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

Browse Source
This commit is contained in:
speakeasybot
2025-02-08 00:11:23 +00:00
parent 1d1827ef73
commit d833e675dd
134 changed files with 3668 additions and 1621 deletions
Download Patch File Download Diff File Expand all files Collapse all files

162
.speakeasy/gen.lock
View File

File diff suppressed because one or more lines are too long

2
.speakeasy/gen.yaml
View File

@@ -13,7 +13,7 @@ generation:
oAuth2ClientCredentialsEnabled: false
oAuth2PasswordEnabled: false
php:
version: 0.12.7
version: 0.12.8
additionalDependencies:
autoload: {}
autoload-dev: {}

14
.speakeasy/workflow.lock
View File

@@ -1,4 +1,4 @@
speakeasyVersion: 1.487.0
speakeasyVersion: 1.487.1
sources:
my-source:
sourceNamespace: my-source
@@ -9,19 +9,19 @@ sources:
- main
plexapi:
sourceNamespace: plexapi
sourceRevisionDigest: sha256:e6ab335dd91a4165f4510e4a3af8a55819c6310b7e66251266d2384376f3ccae
sourceBlobDigest: sha256:89d1b1133e400c89f0d06efe5e5168f5ba25a413e1ab8380d442d6b233e2e5a9
sourceRevisionDigest: sha256:49536684a97842ea7c069f909012b31a22a046d8277aee47b50a334494bf2c64
sourceBlobDigest: sha256:eac671ea32ce31e1e558839153f7effef39bb35b4e461c6e95661d0eaf4ce1c8
tags:
- latest
- speakeasy-sdk-regen-1738886997
- speakeasy-sdk-regen-1738973394
targets:
plexphp:
source: plexapi
sourceNamespace: plexapi
sourceRevisionDigest: sha256:e6ab335dd91a4165f4510e4a3af8a55819c6310b7e66251266d2384376f3ccae
sourceBlobDigest: sha256:89d1b1133e400c89f0d06efe5e5168f5ba25a413e1ab8380d442d6b233e2e5a9
sourceRevisionDigest: sha256:49536684a97842ea7c069f909012b31a22a046d8277aee47b50a334494bf2c64
sourceBlobDigest: sha256:eac671ea32ce31e1e558839153f7effef39bb35b4e461c6e95661d0eaf4ce1c8
codeSamplesNamespace: code-samples-php-plexphp
codeSamplesRevisionDigest: sha256:4cdb3c552dcc421fe1fec7e86a97ef907ac0ec2e7879d80bcaf8776e93aff650
codeSamplesRevisionDigest: sha256:42ec46311046c3e98c773d65c3c11a6c74c7e0c5e5fb37f1b6fa3427ca45ad83
workflow:
workflowVersion: 1.0.0
speakeasyVersion: latest

3
README.md
View File

@@ -170,12 +170,13 @@ if ($response->object !== null) {
### [library](docs/sdks/library/README.md)
* [deleteLibrary](docs/sdks/library/README.md#deletelibrary) - Delete Library Section
* [getActorsLibrary](docs/sdks/library/README.md#getactorslibrary) - Get Actors of library media
* [getAllLibraries](docs/sdks/library/README.md#getalllibraries) - Get All Libraries
* [getCountriesLibrary](docs/sdks/library/README.md#getcountrieslibrary) - Get Countries of library media
* [getGenresLibrary](docs/sdks/library/README.md#getgenreslibrary) - Get Genres of library media
* [getLibraryDetails](docs/sdks/library/README.md#getlibrarydetails) - Get Library Details
* [getLibraryItems](docs/sdks/library/README.md#getlibraryitems) - Get Library Items
* [getMetaDataByRatingKey](docs/sdks/library/README.md#getmetadatabyratingkey) - Get Metadata by RatingKey
* [getMediaMetaData](docs/sdks/library/README.md#getmediametadata) - Get Media Metadata
* [getRecentlyAddedLibrary](docs/sdks/library/README.md#getrecentlyaddedlibrary) - Get Recently Added
* [getRefreshLibraryMetadata](docs/sdks/library/README.md#getrefreshlibrarymetadata) - Refresh Metadata Of The Library
* [getSearchAllLibraries](docs/sdks/library/README.md#getsearchalllibraries) - Search All Libraries

10
RELEASES.md
View File

@@ -773,3 +773,13 @@ Based on:
- [php v0.12.7] .
### Releases
- [Composer v0.12.7] https://packagist.org/packages/lukehagar/plex-api#v0.12.7 - .
## 2025-02-08 00:09:39
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.487.1 (2.506.0) https://github.com/speakeasy-api/speakeasy
### Generated
- [php v0.12.8] .
### Releases
- [Composer v0.12.8] https://packagist.org/packages/lukehagar/plex-api#v0.12.8 - .

64
codeSamples.yaml
View File

@@ -768,13 +768,14 @@ actions:
update:
x-codeSamples:
- lang: php
label: key
label: data
source: |-
declare(strict_types=1);
require 'vendor/autoload.php';
use LukeHagar\Plex_API;
use LukeHagar\Plex_API\Models\Operations;
$sdk = Plex_API\PlexAPI::builder()
->setSecurity(
@@ -782,10 +783,25 @@ actions:
)
->build();
$request = new Operations\GetMediaMetaDataRequest(
ratingKey: 9518,
includeConcerts: true,
includeExtras: true,
includeOnDeck: true,
includePopularLeaves: true,
includePreferences: true,
includeReviews: true,
includeChapters: true,
includeStations: true,
includeExternalMedia: true,
asyncAugmentMetadata: true,
asyncCheckFiles: true,
asyncRefreshAnalysis: true,
asyncRefreshLocalMediaAgent: true,
);
$response = $sdk->library->getMetaDataByRatingKey(
ratingKey: 9518
$response = $sdk->library->getMediaMetaData(
request: $request
);
if ($response->object !== null) {
@@ -1109,6 +1125,36 @@ actions:
);
if ($response->object !== null) {
// handle response
}
- target: $["paths"]["/library/sections/{sectionKey}/actor"]["get"]
update:
x-codeSamples:
- lang: php
label: library
source: |-
declare(strict_types=1);
require 'vendor/autoload.php';
use LukeHagar\Plex_API;
use LukeHagar\Plex_API\Models\Operations;
$sdk = Plex_API\PlexAPI::builder()
->setSecurity(
'<YOUR_API_KEY_HERE>'
)
->build();
$response = $sdk->library->getActorsLibrary(
sectionKey: 9518,
type: Operations\GetActorsLibraryQueryParamType::TvShow
);
if ($response->object !== null) {
// handle response
}
@@ -1123,6 +1169,7 @@ actions:
require 'vendor/autoload.php';
use LukeHagar\Plex_API;
use LukeHagar\Plex_API\Models\Operations;
$sdk = Plex_API\PlexAPI::builder()
->setSecurity(
@@ -1133,7 +1180,9 @@ actions:
$response = $sdk->library->getCountriesLibrary(
sectionKey: 9518
sectionKey: 9518,
type: Operations\GetCountriesLibraryQueryParamType::TvShow
);
if ($response->object !== null) {
@@ -1150,6 +1199,7 @@ actions:
require 'vendor/autoload.php';
use LukeHagar\Plex_API;
use LukeHagar\Plex_API\Models\Operations;
$sdk = Plex_API\PlexAPI::builder()
->setSecurity(
@@ -1160,7 +1210,9 @@ actions:
$response = $sdk->library->getGenresLibrary(
sectionKey: 9518
sectionKey: 9518,
type: Operations\GetGenresLibraryQueryParamType::TvShow
);
if ($response->object !== null) {

4
docs/Models/Errors/GetMetaDataByRatingKeyBadRequest.md → docs/Models/Errors/GetActorsLibraryBadRequest.md
View File

@@ -1,4 +1,4 @@
# GetMetaDataByRatingKeyBadRequest
# GetActorsLibraryBadRequest
Bad Request - A parameter was not specified, or was specified incorrectly.
@@ -7,5 +7,5 @@ Bad Request - A parameter was not specified, or was specified incorrectly.
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
| `errors` | array<[Errors\GetMetaDataByRatingKeyErrors](../../Models/Errors/GetMetaDataByRatingKeyErrors.md)> | :heavy_minus_sign: | N/A |
| `errors` | array<[Errors\GetActorsLibraryErrors](../../Models/Errors/GetActorsLibraryErrors.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/Errors/GetMetaDataByRatingKeyErrors.md → docs/Models/Errors/GetActorsLibraryErrors.md
View File

@@ -1,4 +1,4 @@
# GetMetaDataByRatingKeyErrors
# GetActorsLibraryErrors
## Fields

2
docs/Models/Errors/GetMetaDataByRatingKeyLibraryErrors.md → docs/Models/Errors/GetActorsLibraryLibraryErrors.md
View File

@@ -1,4 +1,4 @@
# GetMetaDataByRatingKeyLibraryErrors
# GetActorsLibraryLibraryErrors
## Fields

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

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

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

@@ -0,0 +1,11 @@
# GetMediaMetaDataBadRequest
Bad Request - A parameter was not specified, or was specified incorrectly.
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
| `errors` | array<[Errors\GetMediaMetaDataErrors](../../Models/Errors/GetMediaMetaDataErrors.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/GetMediaMetaDataErrors.md Normal file
View File

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

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

@@ -0,0 +1,10 @@
# GetMediaMetaDataLibraryErrors
## 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/GetMediaMetaDataUnauthorized.md Normal file
View File

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

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

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

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

@@ -0,0 +1,11 @@
# GetActorsLibraryDirectory
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| `fastKey` | *string* | :heavy_check_mark: | A fast lookup key for the actor relative url. | /library/sections/2/all?actor=134671 |
| `thumb` | *string* | :heavy_check_mark: | URL for the thumbnail image of the actor. | https://metadata-static.plex.tv/e/people/e2a915b537ef720252b6d408bc1f91b3.jpg |
| `key` | *string* | :heavy_check_mark: | A unique key representing the actor. | 134671 |
| `title` | *string* | :heavy_check_mark: | The name of the actor. | Aaron Paul |

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

@@ -0,0 +1,20 @@
# GetActorsLibraryMediaContainer
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
| `size` | *float* | :heavy_check_mark: | N/A | 50 |
| `allowSync` | *bool* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
| `art` | *string* | :heavy_check_mark: | URL for the background artwork of the media container. | /:/resources/show-fanart.jpg |
| `identifier` | *string* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
| `mediaTagPrefix` | *string* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
| `mediaTagVersion` | *int* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
| `nocache` | *bool* | :heavy_check_mark: | Specifies whether caching is disabled. | true |
| `thumb` | *string* | :heavy_check_mark: | URL for the thumbnail image of the media container. | /:/resources/show.png |
| `title1` | *string* | :heavy_check_mark: | The primary title of the media container. | TV Series |
| `title2` | *string* | :heavy_check_mark: | The secondary title of the media container. | By Starring Actor |
| `viewGroup` | *string* | :heavy_check_mark: | Identifier for the view group layout. | secondary |
| `viewMode` | *string* | :heavy_check_mark: | Identifier for the view mode. | 131131 |
| `directory` | array<[Operations\GetActorsLibraryDirectory](../../Models/Operations/GetActorsLibraryDirectory.md)> | :heavy_minus_sign: | An array of actor entries for media items. | |

22
docs/Models/Operations/GetActorsLibraryQueryParamType.md Normal file
View File

@@ -0,0 +1,22 @@
# GetActorsLibraryQueryParamType
The type of media to retrieve or filter by.
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 |
| `Audio` | 8 |
| `Album` | 9 |
| `Track` | 10 |

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

@@ -0,0 +1,9 @@
# GetActorsLibraryRequest
## Fields
| 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\GetActorsLibraryQueryParamType](../../Models/Operations/GetActorsLibraryQueryParamType.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |

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

@@ -0,0 +1,11 @@
# GetActorsLibraryResponse
## 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\GetActorsLibraryResponseBody](../../Models/Operations/GetActorsLibraryResponseBody.md) | :heavy_minus_sign: | Successful response containing media container data. |

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

@@ -0,0 +1,10 @@
# GetActorsLibraryResponseBody
Successful response containing media container data.
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
| `mediaContainer` | [?Operations\GetActorsLibraryMediaContainer](../../Models/Operations/GetActorsLibraryMediaContainer.md) | :heavy_minus_sign: | N/A |

22
docs/Models/Operations/GetCountriesLibraryQueryParamType.md Normal file
View File

@@ -0,0 +1,22 @@
# GetCountriesLibraryQueryParamType
The type of media to retrieve or filter by.
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 |
| `Audio` | 8 |
| `Album` | 9 |
| `Track` | 10 |

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

@@ -4,5 +4,6 @@
## Fields
| 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\GetCountriesLibraryQueryParamType](../../Models/Operations/GetCountriesLibraryQueryParamType.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |

22
docs/Models/Operations/GetGenresLibraryQueryParamType.md Normal file
View File

@@ -0,0 +1,22 @@
# GetGenresLibraryQueryParamType
The type of media to retrieve or filter by.
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 |
| `Audio` | 8 |
| `Album` | 9 |
| `Track` | 10 |

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

@@ -4,5 +4,6 @@
## Fields
| 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\GetGenresLibraryQueryParamType](../../Models/Operations/GetGenresLibraryQueryParamType.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |

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

@@ -1,6 +1,6 @@
# GetLibraryItemsQueryParamType
The type of media to retrieve.
The type of media to retrieve or filter by.
1 = movie
2 = show
3 = season

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

@@ -4,11 +4,11 @@
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `tag` | [Operations\Tag](../../Models/Operations/Tag.md) | :heavy_check_mark: | A key representing a specific tag within the section. | |
| `type` | [Operations\GetLibraryItemsQueryParamType](../../Models/Operations/GetLibraryItemsQueryParamType.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
| `sectionKey` | *int* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
| `includeGuids` | [?Operations\IncludeGuids](../../Models/Operations/IncludeGuids.md) | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |
| `type` | [?Operations\GetLibraryItemsQueryParamType](../../Models/Operations/GetLibraryItemsQueryParamType.md) | :heavy_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 |

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

@@ -0,0 +1,10 @@
# GetMediaMetaDataCountry
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- |
| `id` | *int* | :heavy_check_mark: | The unique country identifier. | 58591 |
| `filter` | *string* | :heavy_check_mark: | The filter string for the country. | country=58591 |
| `tag` | *string* | :heavy_check_mark: | The country name. | United States of America |

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

@@ -0,0 +1,13 @@
# GetMediaMetaDataDirector
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | The unique role identifier. | 109501 |
| `filter` | *string* | :heavy_check_mark: | The filter string for the role. | actor=109501 |
| `tag` | *string* | :heavy_check_mark: | The actor's name. | Bob Odenkirk |
| `tagKey` | *string* | :heavy_check_mark: | A key associated with the actor tag. | 5d77683254f42c001f8c3f69 |
| `role` | *?string* | :heavy_minus_sign: | The character name or role. | Jimmy McGill |
| `thumb` | *?string* | :heavy_minus_sign: | URL for the role thumbnail image. | https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg |

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

@@ -0,0 +1,10 @@
# GetMediaMetaDataGenre
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- |
| `id` | *int* | :heavy_check_mark: | The unique genre identifier. | 1057 |
| `filter` | *string* | :heavy_check_mark: | The filter string for the genre. | genre=1057 |
| `tag` | *string* | :heavy_check_mark: | The genre name. | Crime |

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

@@ -0,0 +1,10 @@
# GetMediaMetaDataImage
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- |
| `alt` | *string* | :heavy_check_mark: | Alternate text for the image. | Better Call Saul |
| `type` | *string* | :heavy_check_mark: | The type of image (e.g., coverPoster, background, clearLogo). | coverPoster |
| `url` | *string* | :heavy_check_mark: | The URL of the image. | /library/metadata/44288/thumb/1736487993 |

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

@@ -0,0 +1,8 @@
# GetMediaMetaDataLocation
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
| `path` | *string* | :heavy_check_mark: | The file path for the location. | /TV Shows/Better Call Saul |

22
docs/Models/Operations/GetMediaMetaDataMedia.md Normal file
View File

@@ -0,0 +1,22 @@
# GetMediaMetaDataMedia
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | Unique media identifier. | 387322 |
| `duration` | *int* | :heavy_check_mark: | Duration of the media in milliseconds. | 9610350 |
| `bitrate` | *int* | :heavy_check_mark: | Bitrate in bits per second. | 25512 |
| `width` | *int* | :heavy_check_mark: | Video width in pixels. | 3840 |
| `height` | *int* | :heavy_check_mark: | Video height in pixels. | 1602 |
| `aspectRatio` | *float* | :heavy_check_mark: | Aspect ratio of the video. | 2.35 |
| `audioChannels` | *int* | :heavy_check_mark: | Number of audio channels. | 6 |
| `audioCodec` | *string* | :heavy_check_mark: | Audio codec used. | eac3 |
| `videoCodec` | *string* | :heavy_check_mark: | Video codec used. | hevc |
| `videoResolution` | *string* | :heavy_check_mark: | Video resolution (e.g., 4k). | 4k |
| `container` | *string* | :heavy_check_mark: | File container type. | mkv |
| `videoFrameRate` | *string* | :heavy_check_mark: | Frame rate of the video (e.g., 24p). | 24p |
| `videoProfile` | *string* | :heavy_check_mark: | Video profile (e.g., main 10). | main 10 |
| `hasVoiceActivity` | *bool* | :heavy_check_mark: | Indicates whether voice activity is detected. | false |
| `part` | array<[Operations\GetMediaMetaDataPart](../../Models/Operations/GetMediaMetaDataPart.md)> | :heavy_check_mark: | An array of parts for this media item. | |

16
docs/Models/Operations/GetMediaMetaDataMediaContainer.md Normal file
View File

@@ -0,0 +1,16 @@
# GetMediaMetaDataMediaContainer
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
| `size` | *float* | :heavy_check_mark: | N/A | 50 |
| `allowSync` | *bool* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
| `identifier` | *string* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
| `librarySectionID` | *int* | :heavy_check_mark: | The unique identifier for the library section. | 2 |
| `librarySectionTitle` | *string* | :heavy_check_mark: | The title of the library section. | TV Series |
| `mediaTagPrefix` | *string* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
| `mediaTagVersion` | *int* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
| `metadata` | array<[Operations\GetMediaMetaDataMetadata](../../Models/Operations/GetMediaMetaDataMetadata.md)> | :heavy_check_mark: | An array of metadata items. | |
| `librarySectionUUID` | *?string* | :heavy_minus_sign: | The universally unique identifier for the library section. | e69655a2-ef48-4aba-bb19-0cc34d1e7d36 |

101
docs/Models/Operations/GetMetaDataByRatingKeyMetadata.md → docs/Models/Operations/GetMediaMetaDataMetadata.md
View File

@@ -1,45 +1,66 @@
# GetMetaDataByRatingKeyMetadata
# GetMediaMetaDataMetadata
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `ratingKey` | *?string* | :heavy_minus_sign: | N/A | 17 |
| `key` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/17 |
| `guid` | *?string* | :heavy_minus_sign: | N/A | plex://movie/5d77683f6f4521001ea9dc53 |
| `studio` | *?string* | :heavy_minus_sign: | N/A | Universal Pictures |
| `type` | *?string* | :heavy_minus_sign: | N/A | movie |
| `title` | *?string* | :heavy_minus_sign: | N/A | Serenity |
| `librarySectionTitle` | *?string* | :heavy_minus_sign: | N/A | Movies |
| `librarySectionID` | *?int* | :heavy_minus_sign: | N/A | 1 |
| `librarySectionKey` | *?string* | :heavy_minus_sign: | N/A | /library/sections/1 |
| `grandparentTitle` | *?string* | :heavy_minus_sign: | The name of the album artist for the track when audio, and the name of the TV show for the episode when video. | |
| `parentTitle` | *?string* | :heavy_minus_sign: | The name of the album for the track when audio, and the name of the season for the episode when TV show. | |
| `originalTitle` | *?string* | :heavy_minus_sign: | The orginal untranslated name of the media item when non-english. | |
| `index` | *?int* | :heavy_minus_sign: | The index starting from 0 of this media item in the MetaData array. | |
| `parentIndex` | *?int* | :heavy_minus_sign: | The parent index starting from 0 of this media item in the parent MetaData array. | |
| `contentRating` | *?string* | :heavy_minus_sign: | N/A | PG-13 |
| `summary` | *?string* | :heavy_minus_sign: | N/A | Serenity continues the story of the TV series it was based upon ("Firefly"). River Tam had a secret - one in which she's not even aware - so dangerous, no one's safe, as an Alliance operative's sent to capture her, and all others are considered irrelevant to his job. |
| `rating` | *?float* | :heavy_minus_sign: | N/A | 8.2 |
| `audienceRating` | *?float* | :heavy_minus_sign: | N/A | 9.1 |
| `year` | *?int* | :heavy_minus_sign: | N/A | 2005 |
| `tagline` | *?string* | :heavy_minus_sign: | N/A | They aim to misbehave. |
| `thumb` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/17/thumb/1705637165 |
| `art` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/17/art/1705637165 |
| `duration` | *?int* | :heavy_minus_sign: | N/A | 141417 |
| `originallyAvailableAt` | [\DateTime](https://www.php.net/manual/en/class.datetime.php) | :heavy_minus_sign: | N/A | 2005-09-29 00:00:00 +0000 UTC |
| `addedAt` | *?int* | :heavy_minus_sign: | N/A | 1705637164 |
| `updatedAt` | *?int* | :heavy_minus_sign: | N/A | 1705637165 |
| `audienceRatingImage` | *?string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright |
| `hasPremiumPrimaryExtra` | *?string* | :heavy_minus_sign: | N/A | 1 |
| `ratingImage` | *?string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.ripe |
| `media` | array<[Operations\GetMetaDataByRatingKeyMedia](../../Models/Operations/GetMetaDataByRatingKeyMedia.md)> | :heavy_minus_sign: | N/A | |
| `genre` | array<[Operations\GetMetaDataByRatingKeyGenre](../../Models/Operations/GetMetaDataByRatingKeyGenre.md)> | :heavy_minus_sign: | N/A | |
| `country` | array<[Operations\GetMetaDataByRatingKeyCountry](../../Models/Operations/GetMetaDataByRatingKeyCountry.md)> | :heavy_minus_sign: | N/A | |
| `guids` | array<[Operations\Guids](../../Models/Operations/Guids.md)> | :heavy_minus_sign: | N/A | |
| `ratings` | array<[Operations\Ratings](../../Models/Operations/Ratings.md)> | :heavy_minus_sign: | N/A | |
| `director` | array<[Operations\GetMetaDataByRatingKeyDirector](../../Models/Operations/GetMetaDataByRatingKeyDirector.md)> | :heavy_minus_sign: | N/A | |
| `writer` | array<[Operations\GetMetaDataByRatingKeyWriter](../../Models/Operations/GetMetaDataByRatingKeyWriter.md)> | :heavy_minus_sign: | N/A | |
| `role` | array<[Operations\GetMetaDataByRatingKeyRole](../../Models/Operations/GetMetaDataByRatingKeyRole.md)> | :heavy_minus_sign: | N/A | |
| `producer` | array<[Operations\Producer](../../Models/Operations/Producer.md)> | :heavy_minus_sign: | N/A | |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `ratingKey` | *string* | :heavy_check_mark: | The rating key of the metadata item. | 44288 |
| `key` | *string* | :heavy_check_mark: | The API key to access metadata details. | /library/metadata/44288/children |
| `guid` | *string* | :heavy_check_mark: | The globally unique identifier for the item. | plex://show/5d9c08254eefaa001f5d6dcb |
| `type` | *string* | :heavy_check_mark: | The type of content (e.g., show, movie). | show |
| `title` | *string* | :heavy_check_mark: | The title of the content. | Better Call Saul |
| `librarySectionTitle` | *string* | :heavy_check_mark: | The title of the library section. | TV Series |
| `librarySectionID` | *int* | :heavy_check_mark: | The ID of the library section. | 2 |
| `librarySectionKey` | *string* | :heavy_check_mark: | The key of the library section. | /library/sections/2 |
| `contentRating` | *string* | :heavy_check_mark: | The content rating (e.g., TV-MA). | TV-MA |
| `summary` | *string* | :heavy_check_mark: | A summary of the content. | Before Saul Goodman, he was Jimmy McGill. And if you're calling Jimmy, you're in real trouble. The prequel to "Breaking Bad" follows small-time attorney, Jimmy McGill, as he transforms into Walter White's morally challenged lawyer, Saul Goodman. |
| `audienceRating` | *float* | :heavy_check_mark: | The audience rating for the content. | 8.7 |
| `year` | *int* | :heavy_check_mark: | The release year. | 2015 |
| `thumb` | *string* | :heavy_check_mark: | URL of the thumbnail image. | /library/metadata/44288/thumb/1736487993 |
| `art` | *string* | :heavy_check_mark: | URL of the art image. | /library/metadata/44288/art/1736487993 |
| `duration` | *int* | :heavy_check_mark: | Duration of the content in milliseconds. | 2700000 |
| `originallyAvailableAt` | [\DateTime](https://www.php.net/manual/en/class.datetime.php) | :heavy_check_mark: | The original release date. | 2015-02-08 |
| `addedAt` | *int* | :heavy_check_mark: | Unix timestamp when the item was added. | 1625505101 |
| `updatedAt` | *int* | :heavy_check_mark: | Unix timestamp when the item was last updated. | 1736487993 |
| `audienceRatingImage` | *string* | :heavy_check_mark: | The URL for the audience rating image. | themoviedb://image.rating |
| `image` | array<[Operations\GetMediaMetaDataImage](../../Models/Operations/GetMediaMetaDataImage.md)> | :heavy_check_mark: | An array of image objects. | |
| `ultraBlurColors` | [Operations\GetMediaMetaDataUltraBlurColors](../../Models/Operations/GetMediaMetaDataUltraBlurColors.md) | :heavy_check_mark: | N/A | |
| `guids` | array<[Operations\Guids](../../Models/Operations/Guids.md)> | :heavy_check_mark: | An array of GUID objects. | |
| `rating` | array<[Operations\Rating](../../Models/Operations/Rating.md)> | :heavy_check_mark: | An array of rating objects. | |
| `parentRatingKey` | *?string* | :heavy_minus_sign: | The rating key of the parent of this metadata item. | 48047 |
| `grandparentRatingKey` | *?string* | :heavy_minus_sign: | The rating key of the grandparent of this metadata item. | 45520 |
| `parentGuid` | *?string* | :heavy_minus_sign: | A GUID identifying the parent entity (e.g., season) for the item. | plex://season/618b89208dde18df707ad15c |
| `grandparentGuid` | *?string* | :heavy_minus_sign: | A GUID identifying the grandparent entity (e.g., show). | plex://show/5e16253691c20300412003a8 |
| `grandparentSlug` | *?string* | :heavy_minus_sign: | A URL-friendly identifier (slug) for the grandparent entity. | alice-in-borderland-2020 |
| `grandparentKey` | *?string* | :heavy_minus_sign: | A key identifying the grandparent metadata in the library. | /library/metadata/45520 |
| `parentKey` | *?string* | :heavy_minus_sign: | A key identifying the parent metadata in the library. | /library/metadata/48047 |
| `slug` | *?string* | :heavy_minus_sign: | A URL-friendly identifier for the item. | better-call-saul |
| `studio` | *?string* | :heavy_minus_sign: | The studio that produced the content. | Sony Pictures Television |
| `originalTitle` | *?string* | :heavy_minus_sign: | The original title of the content. | Wicked: Part I |
| `index` | *?int* | :heavy_minus_sign: | The index or order of the item. | 1 |
| `grandparentTitle` | *?string* | :heavy_minus_sign: | The title of the grandparent entity (typically the show's title). | Alice in Borderland |
| `parentTitle` | *?string* | :heavy_minus_sign: | The title of the parent entity (typically the season's title). | Season 2 |
| `viewCount` | *?int* | :heavy_minus_sign: | The number of times the item has been viewed. | 4 |
| `skipCount` | *?int* | :heavy_minus_sign: | The number of times the item has been skipped. | 1 |
| `lastViewedAt` | *?int* | :heavy_minus_sign: | Unix timestamp of when the item was last viewed. | 1625764795 |
| `tagline` | *?string* | :heavy_minus_sign: | The tagline of the content. | Make the call |
| `chapterSource` | *?string* | :heavy_minus_sign: | N/A | media |
| `primaryExtraKey` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/134704 |
| `theme` | *?string* | :heavy_minus_sign: | URL of the theme image. | /library/metadata/44288/theme/1736487993 |
| `leafCount` | *?int* | :heavy_minus_sign: | The total number of episodes (or leaves). | 63 |
| `viewedLeafCount` | *?int* | :heavy_minus_sign: | The number of episodes that have been viewed. | 4 |
| `childCount` | *?int* | :heavy_minus_sign: | The number of child items. | 6 |
| `parentIndex` | *?int* | :heavy_minus_sign: | The index number of the parent entity, which could indicate its order or position. | 2 |
| `parentThumb` | *?string* | :heavy_minus_sign: | The URL of the parent's thumbnail image. | /library/metadata/48047/thumb/1671800243 |
| `grandparentThumb` | *?string* | :heavy_minus_sign: | The URL of the grandparent's thumbnail image. | /library/metadata/45520/thumb/1736488003 |
| `grandparentArt` | *?string* | :heavy_minus_sign: | The URL of the grandparent's art image. | /library/metadata/45520/art/1736488003 |
| `media` | array<[Operations\GetMediaMetaDataMedia](../../Models/Operations/GetMediaMetaDataMedia.md)> | :heavy_minus_sign: | N/A | |
| `genre` | array<[Operations\GetMediaMetaDataGenre](../../Models/Operations/GetMediaMetaDataGenre.md)> | :heavy_minus_sign: | An array of genre tags. | |
| `country` | array<[Operations\GetMediaMetaDataCountry](../../Models/Operations/GetMediaMetaDataCountry.md)> | :heavy_minus_sign: | An array of country tags. | |
| `role` | array<[Operations\GetMediaMetaDataRole](../../Models/Operations/GetMediaMetaDataRole.md)> | :heavy_minus_sign: | An array of Actor roles. | |
| `director` | array<[Operations\GetMediaMetaDataDirector](../../Models/Operations/GetMediaMetaDataDirector.md)> | :heavy_minus_sign: | An array of Director roles. | |
| `writer` | array<[Operations\GetMediaMetaDataWriter](../../Models/Operations/GetMediaMetaDataWriter.md)> | :heavy_minus_sign: | An array of Writer roles. | |
| `producer` | array<[Operations\Producer](../../Models/Operations/Producer.md)> | :heavy_minus_sign: | An array of Writer roles. | |
| `similar` | array<[Operations\Similar](../../Models/Operations/Similar.md)> | :heavy_minus_sign: | An array of similar content objects. | |
| `location` | array<[Operations\GetMediaMetaDataLocation](../../Models/Operations/GetMediaMetaDataLocation.md)> | :heavy_minus_sign: | An array of location objects. | |

18
docs/Models/Operations/GetMediaMetaDataPart.md Normal file
View File

@@ -0,0 +1,18 @@
# GetMediaMetaDataPart
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | Unique part identifier. | 418385 |
| `key` | *string* | :heavy_check_mark: | Key to access this part. | /library/parts/418385/1735864239/file.mkv |
| `duration` | *int* | :heavy_check_mark: | Duration of the part in milliseconds. | 9610350 |
| `file` | *string* | :heavy_check_mark: | File path for the part. | /mnt/Movies_1/W/Wicked (2024).mkv |
| `size` | *int* | :heavy_check_mark: | File size in bytes. | 30649952104 |
| `container` | *string* | :heavy_check_mark: | Container format of the part. | mkv |
| `videoProfile` | *string* | :heavy_check_mark: | Video profile for the part. | main 10 |
| `stream` | array<[Operations\GetMediaMetaDataStream](../../Models/Operations/GetMediaMetaDataStream.md)> | :heavy_check_mark: | An array of streams for this part. | |
| `accessible` | *?bool* | :heavy_minus_sign: | Indicates if the part is accessible. | true |
| `exists` | *?bool* | :heavy_minus_sign: | Indicates if the part exists. | true |
| `indexes` | *?string* | :heavy_minus_sign: | N/A | sd |

21
docs/Models/Operations/GetMediaMetaDataRequest.md Normal file
View File

@@ -0,0 +1,21 @@
# GetMediaMetaDataRequest
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ |
| `ratingKey` | *int* | :heavy_check_mark: | the id of the library item to return the children of. | 9518 |
| `includeConcerts` | *?bool* | :heavy_minus_sign: | Include concerts data if set to true. | true |
| `includeExtras` | *?bool* | :heavy_minus_sign: | Include extra content (e.g. bonus features). | true |
| `includeOnDeck` | *?bool* | :heavy_minus_sign: | Include on-deck items. | true |
| `includePopularLeaves` | *?bool* | :heavy_minus_sign: | Include popular leaves (episodes/chapters). | true |
| `includePreferences` | *?bool* | :heavy_minus_sign: | Include preferences information. | true |
| `includeReviews` | *?bool* | :heavy_minus_sign: | Include reviews for the content. | true |
| `includeChapters` | *?bool* | :heavy_minus_sign: | Include chapter details. | true |
| `includeStations` | *?bool* | :heavy_minus_sign: | Include station data. | true |
| `includeExternalMedia` | *?bool* | :heavy_minus_sign: | Include external media data. | true |
| `asyncAugmentMetadata` | *?bool* | :heavy_minus_sign: | Trigger asynchronous metadata augmentation. | true |
| `asyncCheckFiles` | *?bool* | :heavy_minus_sign: | Trigger asynchronous file checking. | true |
| `asyncRefreshAnalysis` | *?bool* | :heavy_minus_sign: | Trigger asynchronous refresh of analysis. | true |
| `asyncRefreshLocalMediaAgent` | *?bool* | :heavy_minus_sign: | Trigger asynchronous refresh of the local media agent. | true |

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

@@ -0,0 +1,11 @@
# GetMediaMetaDataResponse
## 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\GetMediaMetaDataResponseBody](../../Models/Operations/GetMediaMetaDataResponseBody.md) | :heavy_minus_sign: | The metadata of the library item. |

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

@@ -0,0 +1,10 @@
# GetMediaMetaDataResponseBody
The metadata of the library item.
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
| `mediaContainer` | [?Operations\GetMediaMetaDataMediaContainer](../../Models/Operations/GetMediaMetaDataMediaContainer.md) | :heavy_minus_sign: | N/A |

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

@@ -0,0 +1,13 @@
# GetMediaMetaDataRole
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | The unique role identifier. | 109501 |
| `filter` | *string* | :heavy_check_mark: | The filter string for the role. | actor=109501 |
| `tag` | *string* | :heavy_check_mark: | The actor's name. | Bob Odenkirk |
| `tagKey` | *string* | :heavy_check_mark: | A key associated with the actor tag. | 5d77683254f42c001f8c3f69 |
| `role` | *?string* | :heavy_minus_sign: | The character name or role. | Jimmy McGill |
| `thumb` | *?string* | :heavy_minus_sign: | URL for the role thumbnail image. | https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg |

53
docs/Models/Operations/GetMediaMetaDataStream.md Normal file
View File

@@ -0,0 +1,53 @@
# GetMediaMetaDataStream
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | Unique stream identifier. | 1002625 |
| `streamType` | *int* | :heavy_check_mark: | Stream type (1=video, 2=audio, 3=subtitle). | 1 |
| `codec` | *string* | :heavy_check_mark: | Codec used by the stream. | hevc |
| `index` | *int* | :heavy_check_mark: | Index of the stream. | 0 |
| `bitrate` | *int* | :heavy_check_mark: | Bitrate of the stream. | 24743 |
| `language` | *string* | :heavy_check_mark: | Language of the stream. | English |
| `languageTag` | *string* | :heavy_check_mark: | Language tag (e.g., en). | en |
| `languageCode` | *string* | :heavy_check_mark: | ISO language code. | eng |
| `displayTitle` | *string* | :heavy_check_mark: | Display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
| `extendedDisplayTitle` | *string* | :heavy_check_mark: | Extended display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
| `default` | *?bool* | :heavy_minus_sign: | Indicates if this stream is default. | true |
| `doviblCompatID` | *?int* | :heavy_minus_sign: | Dolby Vision BL compatibility ID. | 1 |
| `doviblPresent` | *?bool* | :heavy_minus_sign: | Indicates if Dolby Vision BL is present. | true |
| `dovielPresent` | *?bool* | :heavy_minus_sign: | Indicates if Dolby Vision EL is present. | false |
| `doviLevel` | *?int* | :heavy_minus_sign: | Dolby Vision level. | 6 |
| `doviPresent` | *?bool* | :heavy_minus_sign: | Indicates if Dolby Vision is present. | true |
| `doviProfile` | *?int* | :heavy_minus_sign: | Dolby Vision profile. | 8 |
| `dovirpuPresent` | *?bool* | :heavy_minus_sign: | Indicates if Dolby Vision RPU is present. | true |
| `doviVersion` | *?string* | :heavy_minus_sign: | Dolby Vision version. | 1.0 |
| `bitDepth` | *?int* | :heavy_minus_sign: | Bit depth of the video stream. | 10 |
| `chromaLocation` | *?string* | :heavy_minus_sign: | Chroma sample location. | topleft |
| `chromaSubsampling` | *?string* | :heavy_minus_sign: | Chroma subsampling format. | 4:2:0 |
| `codedHeight` | *?int* | :heavy_minus_sign: | Coded video height. | 1608 |
| `codedWidth` | *?int* | :heavy_minus_sign: | Coded video width. | 3840 |
| `colorPrimaries` | *?string* | :heavy_minus_sign: | Color primaries used. | bt2020 |
| `colorRange` | *?string* | :heavy_minus_sign: | Color range (e.g., tv). | tv |
| `colorSpace` | *?string* | :heavy_minus_sign: | Color space. | bt2020nc |
| `colorTrc` | *?string* | :heavy_minus_sign: | Color transfer characteristics. | smpte2084 |
| `frameRate` | *?float* | :heavy_minus_sign: | Frame rate of the stream. | 23.976 |
| `height` | *?int* | :heavy_minus_sign: | Height of the video stream. | 1602 |
| `level` | *?int* | :heavy_minus_sign: | Video level. | 150 |
| `original` | *?bool* | :heavy_minus_sign: | Indicates if this is the original stream. | true |
| `hasScalingMatrix` | *?bool* | :heavy_minus_sign: | N/A | false |
| `profile` | *?string* | :heavy_minus_sign: | Video profile. | main 10 |
| `scanType` | *?string* | :heavy_minus_sign: | N/A | progressive |
| `refFrames` | *?int* | :heavy_minus_sign: | Number of reference frames. | 1 |
| `width` | *?int* | :heavy_minus_sign: | Width of the video stream. | 3840 |
| `selected` | *?bool* | :heavy_minus_sign: | Indicates if this stream is selected (applicable for audio streams). | true |
| `forced` | *?bool* | :heavy_minus_sign: | N/A | true |
| `channels` | *?int* | :heavy_minus_sign: | Number of audio channels (for audio streams). | 6 |
| `audioChannelLayout` | *?string* | :heavy_minus_sign: | Audio channel layout. | 5.1(side) |
| `samplingRate` | *?int* | :heavy_minus_sign: | Sampling rate for the audio stream. | 48000 |
| `canAutoSync` | *?bool* | :heavy_minus_sign: | Indicates if the stream can auto-sync. | false |
| `hearingImpaired` | *?bool* | :heavy_minus_sign: | Indicates if the stream is for the hearing impaired. | true |
| `dub` | *?bool* | :heavy_minus_sign: | Indicates if the stream is a dub. | true |
| `title` | *?string* | :heavy_minus_sign: | Optional title for the stream (e.g., language variant). | SDH |

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

@@ -0,0 +1,11 @@
# GetMediaMetaDataUltraBlurColors
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------- | ----------------------------- | ----------------------------- | ----------------------------- | ----------------------------- |
| `topLeft` | *string* | :heavy_check_mark: | The top-left color value. | 11333a |
| `topRight` | *string* | :heavy_check_mark: | The top-right color value. | 1d2721 |
| `bottomRight` | *string* | :heavy_check_mark: | The bottom-right color value. | 5c451d |
| `bottomLeft` | *string* | :heavy_check_mark: | The bottom-left color value. | 372c10 |

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

@@ -0,0 +1,13 @@
# GetMediaMetaDataWriter
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | The unique role identifier. | 109501 |
| `filter` | *string* | :heavy_check_mark: | The filter string for the role. | actor=109501 |
| `tag` | *string* | :heavy_check_mark: | The actor's name. | Bob Odenkirk |
| `tagKey` | *string* | :heavy_check_mark: | A key associated with the actor tag. | 5d77683254f42c001f8c3f69 |
| `role` | *?string* | :heavy_minus_sign: | The character name or role. | Jimmy McGill |
| `thumb` | *?string* | :heavy_minus_sign: | URL for the role thumbnail image. | https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg |

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

@@ -1,10 +0,0 @@
# GetMetaDataByRatingKeyCountry
## Fields
| Field | Type | Required | Description | Example |
| ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ |
| `id` | *?int* | :heavy_minus_sign: | N/A | 116 |
| `filter` | *?string* | :heavy_minus_sign: | N/A | country=116 |
| `tag` | *?string* | :heavy_minus_sign: | N/A | United States of America |

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

@@ -1,12 +0,0 @@
# GetMetaDataByRatingKeyDirector
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
| `id` | *?int* | :heavy_minus_sign: | N/A | 130 |
| `filter` | *?string* | :heavy_minus_sign: | N/A | director=130 |
| `tag` | *?string* | :heavy_minus_sign: | N/A | Joss Whedon |
| `tagKey` | *?string* | :heavy_minus_sign: | N/A | 5d776828880197001ec90e8f |
| `thumb` | *?string* | :heavy_minus_sign: | N/A | https://metadata-static.plex.tv/people/5d776828880197001ec90e8f.jpg |

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

@@ -1,10 +0,0 @@
# GetMetaDataByRatingKeyGenre
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `id` | *?int* | :heavy_minus_sign: | N/A | 184 |
| `filter` | *?string* | :heavy_minus_sign: | N/A | genre=184 |
| `tag` | *?string* | :heavy_minus_sign: | N/A | Thriller |

24
docs/Models/Operations/GetMetaDataByRatingKeyMedia.md
View File

@@ -1,24 +0,0 @@
# GetMetaDataByRatingKeyMedia
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
| `id` | *?int* | :heavy_minus_sign: | N/A | 15 |
| `duration` | *?int* | :heavy_minus_sign: | N/A | 141417 |
| `bitrate` | *?int* | :heavy_minus_sign: | N/A | 2278 |
| `width` | *?int* | :heavy_minus_sign: | N/A | 1920 |
| `height` | *?int* | :heavy_minus_sign: | N/A | 814 |
| `aspectRatio` | *?float* | :heavy_minus_sign: | N/A | 2.35 |
| `audioChannels` | *?int* | :heavy_minus_sign: | N/A | 2 |
| `audioCodec` | *?string* | :heavy_minus_sign: | N/A | aac |
| `videoCodec` | *?string* | :heavy_minus_sign: | N/A | h264 |
| `videoResolution` | *?string* | :heavy_minus_sign: | N/A | 1080 |
| `container` | *?string* | :heavy_minus_sign: | N/A | mp4 |
| `videoFrameRate` | *?string* | :heavy_minus_sign: | N/A | 24p |
| `optimizedForStreaming` | *?int* | :heavy_minus_sign: | N/A | 0 |
| `audioProfile` | *?string* | :heavy_minus_sign: | N/A | lc |
| `has64bitOffsets` | *?bool* | :heavy_minus_sign: | N/A | false |
| `videoProfile` | *?string* | :heavy_minus_sign: | N/A | high |
| `part` | array<[Operations\GetMetaDataByRatingKeyPart](../../Models/Operations/GetMetaDataByRatingKeyPart.md)> | :heavy_minus_sign: | N/A | |

16
docs/Models/Operations/GetMetaDataByRatingKeyMediaContainer.md
View File

@@ -1,16 +0,0 @@
# GetMetaDataByRatingKeyMediaContainer
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
| `size` | *?int* | :heavy_minus_sign: | N/A | 1 |
| `allowSync` | *?bool* | :heavy_minus_sign: | N/A | true |
| `identifier` | *?string* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
| `librarySectionID` | *?int* | :heavy_minus_sign: | N/A | 1 |
| `librarySectionTitle` | *?string* | :heavy_minus_sign: | N/A | Movies |
| `librarySectionUUID` | *?string* | :heavy_minus_sign: | N/A | cfc899d7-3000-46f6-8489-b9592714ada5 |
| `mediaTagPrefix` | *?string* | :heavy_minus_sign: | N/A | /system/bundle/media/flags/ |
| `mediaTagVersion` | *?int* | :heavy_minus_sign: | N/A | 1698860922 |
| `metadata` | array<[Operations\GetMetaDataByRatingKeyMetadata](../../Models/Operations/GetMetaDataByRatingKeyMetadata.md)> | :heavy_minus_sign: | N/A | |

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

@@ -1,18 +0,0 @@
# GetMetaDataByRatingKeyPart
## 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 |
| `file` | *?string* | :heavy_minus_sign: | N/A | /movies/Serenity (2005)/Serenity (2005).mp4 |
| `size` | *?int* | :heavy_minus_sign: | N/A | 40271948 |
| `audioProfile` | *?string* | :heavy_minus_sign: | N/A | lc |
| `container` | *?string* | :heavy_minus_sign: | N/A | mp4 |
| `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\GetMetaDataByRatingKeyStream](../../Models/Operations/GetMetaDataByRatingKeyStream.md)> | :heavy_minus_sign: | N/A | |

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

@@ -1,8 +0,0 @@
# GetMetaDataByRatingKeyRequest
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
| `ratingKey` | *int* | :heavy_check_mark: | the id of the library item to return the children of. | 9518 |

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

@@ -1,11 +0,0 @@
# GetMetaDataByRatingKeyResponse
## 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\GetMetaDataByRatingKeyResponseBody](../../Models/Operations/GetMetaDataByRatingKeyResponseBody.md) | :heavy_minus_sign: | The metadata of the library item. |

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

@@ -1,10 +0,0 @@
# GetMetaDataByRatingKeyResponseBody
The metadata of the library item.
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
| `mediaContainer` | [?Operations\GetMetaDataByRatingKeyMediaContainer](../../Models/Operations/GetMetaDataByRatingKeyMediaContainer.md) | :heavy_minus_sign: | N/A |

13
docs/Models/Operations/GetMetaDataByRatingKeyRole.md
View File

@@ -1,13 +0,0 @@
# GetMetaDataByRatingKeyRole
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| `id` | *?int* | :heavy_minus_sign: | N/A | 220 |
| `filter` | *?string* | :heavy_minus_sign: | N/A | actor=220 |
| `tag` | *?string* | :heavy_minus_sign: | N/A | Dennis Keiffer |
| `tagKey` | *?string* | :heavy_minus_sign: | N/A | 5d77683554f42c001f8c4708 |
| `role` | *?string* | :heavy_minus_sign: | N/A | Bar Guy (uncredited) |
| `thumb` | *?string* | :heavy_minus_sign: | N/A | https://metadata-static.plex.tv/6/people/648e9a7ea1d537bccfcd7615134b78ce.jpg |

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

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

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

@@ -1,12 +0,0 @@
# GetMetaDataByRatingKeyWriter
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
| `id` | *?int* | :heavy_minus_sign: | N/A | 132 |
| `filter` | *?string* | :heavy_minus_sign: | N/A | writer=132 |
| `tag` | *?string* | :heavy_minus_sign: | N/A | Joss Whedon |
| `tagKey` | *?string* | :heavy_minus_sign: | N/A | 5d776828880197001ec90e8f |
| `thumb` | *?string* | :heavy_minus_sign: | N/A | https://metadata-static.plex.tv/people/5d776828880197001ec90e8f.jpg |

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

@@ -1,6 +1,6 @@
# GetPlaylistContentsQueryParamType
The type of media to retrieve.
The type of media to retrieve or filter by.
1 = movie
2 = show
3 = season

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

@@ -4,6 +4,6 @@
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `playlistID` | *float* | :heavy_check_mark: | the ID of the playlist | |
| `type` | [Operations\GetPlaylistContentsQueryParamType](../../Models/Operations/GetPlaylistContentsQueryParamType.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\GetPlaylistContentsQueryParamType](../../Models/Operations/GetPlaylistContentsQueryParamType.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |

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

@@ -4,8 +4,8 @@
## 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 |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `type` | [Operations\QueryParamType](../../Models/Operations/QueryParamType.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
| `contentDirectoryID` | *?int* | :heavy_minus_sign: | N/A | 2 |
| `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 |

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

@@ -4,9 +4,9 @@
## Fields
| 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 |
| `type` | [Operations\Type](../../Models/Operations/Type.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
| `pinnedContentDirectoryID` | *?string* | :heavy_minus_sign: | Comma-separated list of pinned content directory IDs. | |
| `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 |

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

@@ -1,6 +1,6 @@
# GetSearchLibraryQueryParamType
The type of media to retrieve.
The type of media to retrieve or filter by.
1 = movie
2 = show
3 = season

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

@@ -4,6 +4,6 @@
## Fields
| 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\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 |
| `type` | [Operations\GetSearchLibraryQueryParamType](../../Models/Operations/GetSearchLibraryQueryParamType.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |

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

@@ -1,6 +1,6 @@
# GetTopWatchedContentQueryParamType
The type of media to retrieve.
The type of media to retrieve or filter by.
1 = movie
2 = show
3 = season

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

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

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

@@ -5,4 +5,4 @@
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `id` | *?string* | :heavy_minus_sign: | N/A | tvdb://2337 |
| `id` | *string* | :heavy_check_mark: | The GUID value. | imdb://tt3032476 |

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

@@ -5,8 +5,9 @@
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| `id` | *?int* | :heavy_minus_sign: | N/A | 221 |
| `filter` | *?string* | :heavy_minus_sign: | N/A | producer=221 |
| `tag` | *?string* | :heavy_minus_sign: | N/A | Barry Mendel |
| `tagKey` | *?string* | :heavy_minus_sign: | N/A | 5d776826961905001eb90e2b |
| `thumb` | *?string* | :heavy_minus_sign: | N/A | https://metadata-static.plex.tv/8/people/87877371326a964634d18556d94547e1.jpg |
| `id` | *int* | :heavy_check_mark: | The unique role identifier. | 109501 |
| `filter` | *string* | :heavy_check_mark: | The filter string for the role. | actor=109501 |
| `tag` | *string* | :heavy_check_mark: | The actor's name. | Bob Odenkirk |
| `tagKey` | *string* | :heavy_check_mark: | A key associated with the actor tag. | 5d77683254f42c001f8c3f69 |
| `role` | *?string* | :heavy_minus_sign: | The character name or role. | Jimmy McGill |
| `thumb` | *?string* | :heavy_minus_sign: | URL for the role thumbnail image. | https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg |

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

@@ -1,6 +1,6 @@
# QueryParamType
The type of media to retrieve.
The type of media to retrieve or filter by.
1 = movie
2 = show
3 = season

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

@@ -0,0 +1,10 @@
# Rating
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
| `image` | *string* | :heavy_check_mark: | The image or reference for the rating. | imdb://image.rating |
| `value` | *float* | :heavy_check_mark: | The rating value. | 9 |
| `type` | *string* | :heavy_check_mark: | The type of rating (e.g., audience, critic). | audience |

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

@@ -1,10 +0,0 @@
# Ratings
## Fields
| Field | Type | Required | Description | Example |
| ------------------------- | ------------------------- | ------------------------- | ------------------------- | ------------------------- |
| `image` | *?string* | :heavy_minus_sign: | N/A | themoviedb://image.rating |
| `value` | *?float* | :heavy_minus_sign: | N/A | 7.4 |
| `type` | *?string* | :heavy_minus_sign: | N/A | audience |

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

@@ -0,0 +1,10 @@
# Similar
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
| `id` | *int* | :heavy_check_mark: | The unique similar item identifier. | 26 |
| `filter` | *string* | :heavy_check_mark: | The filter string for similar items. | similar=26 |
| `tag` | *string* | :heavy_check_mark: | The tag or title of the similar content. | Breaking Bad |

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

@@ -1,6 +1,6 @@
# Type
The type of media to retrieve.
The type of media to retrieve or filter by.
1 = movie
2 = show
3 = season

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

@@ -9,12 +9,13 @@ API Calls interacting with Plex Media Server Libraries
### Available Operations
* [deleteLibrary](#deletelibrary) - Delete Library Section
* [getActorsLibrary](#getactorslibrary) - Get Actors of library media
* [getAllLibraries](#getalllibraries) - Get All Libraries
* [getCountriesLibrary](#getcountrieslibrary) - Get Countries of library media
* [getGenresLibrary](#getgenreslibrary) - Get Genres of library media
* [getLibraryDetails](#getlibrarydetails) - Get Library Details
* [getLibraryItems](#getlibraryitems) - Get Library Items
* [getMetaDataByRatingKey](#getmetadatabyratingkey) - Get Metadata by RatingKey
* [getMediaMetaData](#getmediametadata) - Get Media Metadata
* [getRecentlyAddedLibrary](#getrecentlyaddedlibrary) - Get Recently Added
* [getRefreshLibraryMetadata](#getrefreshlibrarymetadata) - Refresh Metadata Of The Library
* [getSearchAllLibraries](#getsearchalllibraries) - Search All Libraries
@@ -72,6 +73,59 @@ if ($response->statusCode === 200) {
| Errors\DeleteLibraryUnauthorized | 401 | application/json |
| Errors\SDKException | 4XX, 5XX | \*/\* |
## getActorsLibrary
Retrieves a list of all the actors that are found for the media in this library.
### Example Usage
```php
declare(strict_types=1);
require 'vendor/autoload.php';
use LukeHagar\Plex_API;
use LukeHagar\Plex_API\Models\Operations;
$sdk = Plex_API\PlexAPI::builder()
->setSecurity(
'<YOUR_API_KEY_HERE>'
)
->build();
$response = $sdk->library->getActorsLibrary(
sectionKey: 9518,
type: Operations\GetActorsLibraryQueryParamType::TvShow
);
if ($response->object !== null) {
// handle response
}
```
### Parameters
| Parameter | 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\GetActorsLibraryQueryParamType](../../Models/Operations/GetActorsLibraryQueryParamType.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
### Response
**[?Operations\GetActorsLibraryResponse](../../Models/Operations/GetActorsLibraryResponse.md)**
### Errors
| Error Type | Status Code | Content Type |
| ----------------------------------- | ----------------------------------- | ----------------------------------- |
| Errors\GetActorsLibraryBadRequest | 400 | application/json |
| Errors\GetActorsLibraryUnauthorized | 401 | application/json |
| Errors\SDKException | 4XX, 5XX | \*/\* |
## getAllLibraries
A library section (commonly referred to as just a library) is a collection of media.
@@ -133,6 +187,7 @@ declare(strict_types=1);
require 'vendor/autoload.php';
use LukeHagar\Plex_API;
use LukeHagar\Plex_API\Models\Operations;
$sdk = Plex_API\PlexAPI::builder()
->setSecurity(
@@ -143,7 +198,9 @@ $sdk = Plex_API\PlexAPI::builder()
$response = $sdk->library->getCountriesLibrary(
sectionKey: 9518
sectionKey: 9518,
type: Operations\GetCountriesLibraryQueryParamType::TvShow
);
if ($response->object !== null) {
@@ -154,8 +211,9 @@ if ($response->object !== null) {
### Parameters
| Parameter | 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\GetCountriesLibraryQueryParamType](../../Models/Operations/GetCountriesLibraryQueryParamType.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
### Response
@@ -182,6 +240,7 @@ declare(strict_types=1);
require 'vendor/autoload.php';
use LukeHagar\Plex_API;
use LukeHagar\Plex_API\Models\Operations;
$sdk = Plex_API\PlexAPI::builder()
->setSecurity(
@@ -192,7 +251,9 @@ $sdk = Plex_API\PlexAPI::builder()
$response = $sdk->library->getGenresLibrary(
sectionKey: 9518
sectionKey: 9518,
type: Operations\GetGenresLibraryQueryParamType::TvShow
);
if ($response->object !== null) {
@@ -203,8 +264,9 @@ if ($response->object !== null) {
### Parameters
| Parameter | 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\GetGenresLibraryQueryParamType](../../Models/Operations/GetGenresLibraryQueryParamType.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
### Response
@@ -352,8 +414,8 @@ $sdk = Plex_API\PlexAPI::builder()
$request = new Operations\GetLibraryItemsRequest(
tag: Operations\Tag::Edition,
sectionKey: 9518,
type: Operations\GetLibraryItemsQueryParamType::TvShow,
sectionKey: 9518,
);
$response = $sdk->library->getLibraryItems(
@@ -383,9 +445,9 @@ if ($response->object !== null) {
| Errors\GetLibraryItemsUnauthorized | 401 | application/json |
| Errors\SDKException | 4XX, 5XX | \*/\* |
## getMetaDataByRatingKey
## getMediaMetaData
This endpoint will return the metadata of a library item specified with the ratingKey.
This endpoint will return all the (meta)data of a library item specified with by the ratingKey.
### Example Usage
@@ -396,6 +458,7 @@ declare(strict_types=1);
require 'vendor/autoload.php';
use LukeHagar\Plex_API;
use LukeHagar\Plex_API\Models\Operations;
$sdk = Plex_API\PlexAPI::builder()
->setSecurity(
@@ -403,10 +466,25 @@ $sdk = Plex_API\PlexAPI::builder()
)
->build();
$request = new Operations\GetMediaMetaDataRequest(
ratingKey: 9518,
includeConcerts: true,
includeExtras: true,
includeOnDeck: true,
includePopularLeaves: true,
includePreferences: true,
includeReviews: true,
includeChapters: true,
includeStations: true,
includeExternalMedia: true,
asyncAugmentMetadata: true,
asyncCheckFiles: true,
asyncRefreshAnalysis: true,
asyncRefreshLocalMediaAgent: true,
);
$response = $sdk->library->getMetaDataByRatingKey(
ratingKey: 9518
$response = $sdk->library->getMediaMetaData(
request: $request
);
if ($response->object !== null) {
@@ -416,20 +494,20 @@ if ($response->object !== null) {
### Parameters
| Parameter | Type | Required | Description | Example |
| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
| `ratingKey` | *int* | :heavy_check_mark: | the id of the library item to return the children of. | 9518 |
| Parameter | Type | Required | Description |
| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
| `$request` | [Operations\GetMediaMetaDataRequest](../../Models/Operations/GetMediaMetaDataRequest.md) | :heavy_check_mark: | The request object to use for the request. |
### Response
**[?Operations\GetMetaDataByRatingKeyResponse](../../Models/Operations/GetMetaDataByRatingKeyResponse.md)**
**[?Operations\GetMediaMetaDataResponse](../../Models/Operations/GetMediaMetaDataResponse.md)**
### Errors
| Error Type | Status Code | Content Type |
| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- |
| Errors\GetMetaDataByRatingKeyBadRequest | 400 | application/json |
| Errors\GetMetaDataByRatingKeyUnauthorized | 401 | application/json |
| ----------------------------------- | ----------------------------------- | ----------------------------------- |
| Errors\GetMediaMetaDataBadRequest | 400 | application/json |
| Errors\GetMediaMetaDataUnauthorized | 401 | application/json |
| Errors\SDKException | 4XX, 5XX | \*/\* |
## getRecentlyAddedLibrary
@@ -663,9 +741,9 @@ if ($response->object !== null) {
### Parameters
| Parameter | 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\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 |
| `type` | [Operations\GetSearchLibraryQueryParamType](../../Models/Operations/GetSearchLibraryQueryParamType.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
### Response
@@ -862,8 +940,8 @@ if ($response->object !== null) {
### Parameters
| Parameter | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `type` | [Operations\GetTopWatchedContentQueryParamType](../../Models/Operations/GetTopWatchedContentQueryParamType.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\GetTopWatchedContentQueryParamType](../../Models/Operations/GetTopWatchedContentQueryParamType.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
| `includeGuids` | *?int* | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |
### Response

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

@@ -321,9 +321,9 @@ if ($response->object !== null) {
### Parameters
| Parameter | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `playlistID` | *float* | :heavy_check_mark: | the ID of the playlist | |
| `type` | [Operations\GetPlaylistContentsQueryParamType](../../Models/Operations/GetPlaylistContentsQueryParamType.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\GetPlaylistContentsQueryParamType](../../Models/Operations/GetPlaylistContentsQueryParamType.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
### Response

140
src/Library.php
View File

@@ -123,6 +123,100 @@ class Library
}
}
/**
* Get Actors of library media
*
* Retrieves a list of all the actors that are found for the media in this library.
*
*
* @param int $sectionKey
* @param Operations\GetActorsLibraryQueryParamType $type
* @return Operations\GetActorsLibraryResponse
* @throws \LukeHagar\Plex_API\Models\Errors\SDKException
*/
public function getActorsLibrary(int $sectionKey, Operations\GetActorsLibraryQueryParamType $type, ?Options $options = null): Operations\GetActorsLibraryResponse
{
$request = new Operations\GetActorsLibraryRequest(
sectionKey: $sectionKey,
type: $type,
);
$baseUrl = Utils\Utils::templateUrl($this->sdkConfiguration->getServerUrl(), $this->sdkConfiguration->getServerDefaults());
$url = Utils\Utils::generateUrl($baseUrl, '/library/sections/{sectionKey}/actor', Operations\GetActorsLibraryRequest::class, $request);
$urlOverride = null;
$httpOptions = ['http_errors' => false];
$qp = Utils\Utils::getQueryParams(Operations\GetActorsLibraryRequest::class, $request, $urlOverride);
$httpOptions['headers']['Accept'] = 'application/json';
$httpOptions['headers']['user-agent'] = $this->sdkConfiguration->userAgent;
$httpRequest = new \GuzzleHttp\Psr7\Request('GET', $url);
$hookContext = new HookContext('get-actors-library', null, $this->sdkConfiguration->securitySource);
$httpRequest = $this->sdkConfiguration->hooks->beforeRequest(new Hooks\BeforeRequestContext($hookContext), $httpRequest);
$httpOptions['query'] = Utils\QueryParameters::standardizeQueryParams($httpRequest, $qp);
$httpOptions = Utils\Utils::convertHeadersToOptions($httpRequest, $httpOptions);
$httpRequest = Utils\Utils::removeHeaders($httpRequest);
try {
$httpResponse = $this->sdkConfiguration->client->send($httpRequest, $httpOptions);
} catch (\GuzzleHttp\Exception\GuzzleException $error) {
$res = $this->sdkConfiguration->hooks->afterError(new Hooks\AfterErrorContext($hookContext), null, $error);
$httpResponse = $res;
}
$contentType = $httpResponse->getHeader('Content-Type')[0] ?? '';
$statusCode = $httpResponse->getStatusCode();
if (Utils\Utils::matchStatusCodes($statusCode, ['400', '401', '404', '4XX', '5XX'])) {
$res = $this->sdkConfiguration->hooks->afterError(new Hooks\AfterErrorContext($hookContext), $httpResponse, null);
$httpResponse = $res;
}
if (Utils\Utils::matchStatusCodes($statusCode, ['200'])) {
if (Utils\Utils::matchContentType($contentType, 'application/json')) {
$httpResponse = $this->sdkConfiguration->hooks->afterSuccess(new Hooks\AfterSuccessContext($hookContext), $httpResponse);
$serializer = Utils\JSON::createSerializer();
$responseData = (string) $httpResponse->getBody();
$obj = $serializer->deserialize($responseData, '\LukeHagar\Plex_API\Models\Operations\GetActorsLibraryResponseBody', 'json', DeserializationContext::create()->setRequireAllRequiredProperties(true));
$response = new Operations\GetActorsLibraryResponse(
statusCode: $statusCode,
contentType: $contentType,
rawResponse: $httpResponse,
object: $obj);
return $response;
} else {
throw new \LukeHagar\Plex_API\Models\Errors\SDKException('Unknown content type received', $statusCode, $httpResponse->getBody()->getContents(), $httpResponse);
}
} elseif (Utils\Utils::matchStatusCodes($statusCode, ['400'])) {
if (Utils\Utils::matchContentType($contentType, 'application/json')) {
$httpResponse = $this->sdkConfiguration->hooks->afterSuccess(new Hooks\AfterSuccessContext($hookContext), $httpResponse);
$serializer = Utils\JSON::createSerializer();
$responseData = (string) $httpResponse->getBody();
$obj = $serializer->deserialize($responseData, '\LukeHagar\Plex_API\Models\Errors\GetActorsLibraryBadRequest', 'json', DeserializationContext::create()->setRequireAllRequiredProperties(true));
$obj->rawResponse = $httpResponse;
throw $obj->toException();
} else {
throw new \LukeHagar\Plex_API\Models\Errors\SDKException('Unknown content type received', $statusCode, $httpResponse->getBody()->getContents(), $httpResponse);
}
} elseif (Utils\Utils::matchStatusCodes($statusCode, ['401'])) {
if (Utils\Utils::matchContentType($contentType, 'application/json')) {
$httpResponse = $this->sdkConfiguration->hooks->afterSuccess(new Hooks\AfterSuccessContext($hookContext), $httpResponse);
$serializer = Utils\JSON::createSerializer();
$responseData = (string) $httpResponse->getBody();
$obj = $serializer->deserialize($responseData, '\LukeHagar\Plex_API\Models\Errors\GetActorsLibraryUnauthorized', 'json', DeserializationContext::create()->setRequireAllRequiredProperties(true));
$obj->rawResponse = $httpResponse;
throw $obj->toException();
} else {
throw new \LukeHagar\Plex_API\Models\Errors\SDKException('Unknown content type received', $statusCode, $httpResponse->getBody()->getContents(), $httpResponse);
}
} elseif (Utils\Utils::matchStatusCodes($statusCode, ['404', '4XX'])) {
throw new \LukeHagar\Plex_API\Models\Errors\SDKException('API error occurred', $statusCode, $httpResponse->getBody()->getContents(), $httpResponse);
} elseif (Utils\Utils::matchStatusCodes($statusCode, ['5XX'])) {
throw new \LukeHagar\Plex_API\Models\Errors\SDKException('API error occurred', $statusCode, $httpResponse->getBody()->getContents(), $httpResponse);
} else {
throw new \LukeHagar\Plex_API\Models\Errors\SDKException('Unknown status code received', $statusCode, $httpResponse->getBody()->getContents(), $httpResponse);
}
}
/**
* Get All Libraries
*
@@ -220,23 +314,28 @@ class Library
*
*
* @param int $sectionKey
* @param Operations\GetCountriesLibraryQueryParamType $type
* @return Operations\GetCountriesLibraryResponse
* @throws \LukeHagar\Plex_API\Models\Errors\SDKException
*/
public function getCountriesLibrary(int $sectionKey, ?Options $options = null): Operations\GetCountriesLibraryResponse
public function getCountriesLibrary(int $sectionKey, Operations\GetCountriesLibraryQueryParamType $type, ?Options $options = null): Operations\GetCountriesLibraryResponse
{
$request = new Operations\GetCountriesLibraryRequest(
sectionKey: $sectionKey,
type: $type,
);
$baseUrl = Utils\Utils::templateUrl($this->sdkConfiguration->getServerUrl(), $this->sdkConfiguration->getServerDefaults());
$url = Utils\Utils::generateUrl($baseUrl, '/library/sections/{sectionKey}/country', Operations\GetCountriesLibraryRequest::class, $request);
$urlOverride = null;
$httpOptions = ['http_errors' => false];
$qp = Utils\Utils::getQueryParams(Operations\GetCountriesLibraryRequest::class, $request, $urlOverride);
$httpOptions['headers']['Accept'] = 'application/json';
$httpOptions['headers']['user-agent'] = $this->sdkConfiguration->userAgent;
$httpRequest = new \GuzzleHttp\Psr7\Request('GET', $url);
$hookContext = new HookContext('get-countries-library', null, $this->sdkConfiguration->securitySource);
$httpRequest = $this->sdkConfiguration->hooks->beforeRequest(new Hooks\BeforeRequestContext($hookContext), $httpRequest);
$httpOptions['query'] = Utils\QueryParameters::standardizeQueryParams($httpRequest, $qp);
$httpOptions = Utils\Utils::convertHeadersToOptions($httpRequest, $httpOptions);
$httpRequest = Utils\Utils::removeHeaders($httpRequest);
try {
@@ -309,23 +408,28 @@ class Library
*
*
* @param int $sectionKey
* @param Operations\GetGenresLibraryQueryParamType $type
* @return Operations\GetGenresLibraryResponse
* @throws \LukeHagar\Plex_API\Models\Errors\SDKException
*/
public function getGenresLibrary(int $sectionKey, ?Options $options = null): Operations\GetGenresLibraryResponse
public function getGenresLibrary(int $sectionKey, Operations\GetGenresLibraryQueryParamType $type, ?Options $options = null): Operations\GetGenresLibraryResponse
{
$request = new Operations\GetGenresLibraryRequest(
sectionKey: $sectionKey,
type: $type,
);
$baseUrl = Utils\Utils::templateUrl($this->sdkConfiguration->getServerUrl(), $this->sdkConfiguration->getServerDefaults());
$url = Utils\Utils::generateUrl($baseUrl, '/library/sections/{sectionKey}/genre', Operations\GetGenresLibraryRequest::class, $request);
$urlOverride = null;
$httpOptions = ['http_errors' => false];
$qp = Utils\Utils::getQueryParams(Operations\GetGenresLibraryRequest::class, $request, $urlOverride);
$httpOptions['headers']['Accept'] = 'application/json';
$httpOptions['headers']['user-agent'] = $this->sdkConfiguration->userAgent;
$httpRequest = new \GuzzleHttp\Psr7\Request('GET', $url);
$hookContext = new HookContext('get-genres-library', null, $this->sdkConfiguration->securitySource);
$httpRequest = $this->sdkConfiguration->hooks->beforeRequest(new Hooks\BeforeRequestContext($hookContext), $httpRequest);
$httpOptions['query'] = Utils\QueryParameters::standardizeQueryParams($httpRequest, $qp);
$httpOptions = Utils\Utils::convertHeadersToOptions($httpRequest, $httpOptions);
$httpRequest = Utils\Utils::removeHeaders($httpRequest);
try {
@@ -633,29 +737,29 @@ class Library
}
/**
* Get Metadata by RatingKey
* Get Media Metadata
*
* This endpoint will return the metadata of a library item specified with the ratingKey.
* This endpoint will return all the (meta)data of a library item specified with by the ratingKey.
*
*
* @param int $ratingKey
* @return Operations\GetMetaDataByRatingKeyResponse
* @param Operations\GetMediaMetaDataRequest $request
* @return Operations\GetMediaMetaDataResponse
* @throws \LukeHagar\Plex_API\Models\Errors\SDKException
*/
public function getMetaDataByRatingKey(int $ratingKey, ?Options $options = null): Operations\GetMetaDataByRatingKeyResponse
public function getMediaMetaData(Operations\GetMediaMetaDataRequest $request, ?Options $options = null): Operations\GetMediaMetaDataResponse
{
$request = new Operations\GetMetaDataByRatingKeyRequest(
ratingKey: $ratingKey,
);
$baseUrl = Utils\Utils::templateUrl($this->sdkConfiguration->getServerUrl(), $this->sdkConfiguration->getServerDefaults());
$url = Utils\Utils::generateUrl($baseUrl, '/library/metadata/{ratingKey}', Operations\GetMetaDataByRatingKeyRequest::class, $request);
$url = Utils\Utils::generateUrl($baseUrl, '/library/metadata/{ratingKey}', Operations\GetMediaMetaDataRequest::class, $request);
$urlOverride = null;
$httpOptions = ['http_errors' => false];
$qp = Utils\Utils::getQueryParams(Operations\GetMediaMetaDataRequest::class, $request, $urlOverride);
$httpOptions['headers']['Accept'] = 'application/json';
$httpOptions['headers']['user-agent'] = $this->sdkConfiguration->userAgent;
$httpRequest = new \GuzzleHttp\Psr7\Request('GET', $url);
$hookContext = new HookContext('get-meta-data-by-rating-key', null, $this->sdkConfiguration->securitySource);
$hookContext = new HookContext('get-media-meta-data', null, $this->sdkConfiguration->securitySource);
$httpRequest = $this->sdkConfiguration->hooks->beforeRequest(new Hooks\BeforeRequestContext($hookContext), $httpRequest);
$httpOptions['query'] = Utils\QueryParameters::standardizeQueryParams($httpRequest, $qp);
$httpOptions = Utils\Utils::convertHeadersToOptions($httpRequest, $httpOptions);
$httpRequest = Utils\Utils::removeHeaders($httpRequest);
try {
@@ -667,7 +771,7 @@ class Library
$contentType = $httpResponse->getHeader('Content-Type')[0] ?? '';
$statusCode = $httpResponse->getStatusCode();
if (Utils\Utils::matchStatusCodes($statusCode, ['400', '401', '4XX', '5XX'])) {
if (Utils\Utils::matchStatusCodes($statusCode, ['400', '401', '404', '4XX', '5XX'])) {
$res = $this->sdkConfiguration->hooks->afterError(new Hooks\AfterErrorContext($hookContext), $httpResponse, null);
$httpResponse = $res;
}
@@ -677,8 +781,8 @@ class Library
$serializer = Utils\JSON::createSerializer();
$responseData = (string) $httpResponse->getBody();
$obj = $serializer->deserialize($responseData, '\LukeHagar\Plex_API\Models\Operations\GetMetaDataByRatingKeyResponseBody', 'json', DeserializationContext::create()->setRequireAllRequiredProperties(true));
$response = new Operations\GetMetaDataByRatingKeyResponse(
$obj = $serializer->deserialize($responseData, '\LukeHagar\Plex_API\Models\Operations\GetMediaMetaDataResponseBody', 'json', DeserializationContext::create()->setRequireAllRequiredProperties(true));
$response = new Operations\GetMediaMetaDataResponse(
statusCode: $statusCode,
contentType: $contentType,
rawResponse: $httpResponse,
@@ -694,7 +798,7 @@ class Library
$serializer = Utils\JSON::createSerializer();
$responseData = (string) $httpResponse->getBody();
$obj = $serializer->deserialize($responseData, '\LukeHagar\Plex_API\Models\Errors\GetMetaDataByRatingKeyBadRequest', 'json', DeserializationContext::create()->setRequireAllRequiredProperties(true));
$obj = $serializer->deserialize($responseData, '\LukeHagar\Plex_API\Models\Errors\GetMediaMetaDataBadRequest', 'json', DeserializationContext::create()->setRequireAllRequiredProperties(true));
$obj->rawResponse = $httpResponse;
throw $obj->toException();
} else {
@@ -706,13 +810,13 @@ class Library
$serializer = Utils\JSON::createSerializer();
$responseData = (string) $httpResponse->getBody();
$obj = $serializer->deserialize($responseData, '\LukeHagar\Plex_API\Models\Errors\GetMetaDataByRatingKeyUnauthorized', 'json', DeserializationContext::create()->setRequireAllRequiredProperties(true));
$obj = $serializer->deserialize($responseData, '\LukeHagar\Plex_API\Models\Errors\GetMediaMetaDataUnauthorized', 'json', DeserializationContext::create()->setRequireAllRequiredProperties(true));
$obj->rawResponse = $httpResponse;
throw $obj->toException();
} else {
throw new \LukeHagar\Plex_API\Models\Errors\SDKException('Unknown content type received', $statusCode, $httpResponse->getBody()->getContents(), $httpResponse);
}
} elseif (Utils\Utils::matchStatusCodes($statusCode, ['4XX'])) {
} elseif (Utils\Utils::matchStatusCodes($statusCode, ['404', '4XX'])) {
throw new \LukeHagar\Plex_API\Models\Errors\SDKException('API error occurred', $statusCode, $httpResponse->getBody()->getContents(), $httpResponse);
} elseif (Utils\Utils::matchStatusCodes($statusCode, ['5XX'])) {
throw new \LukeHagar\Plex_API\Models\Errors\SDKException('API error occurred', $statusCode, $httpResponse->getBody()->getContents(), $httpResponse);

14
src/Models/Errors/GetMetaDataByRatingKeyBadRequest.php → src/Models/Errors/GetActorsLibraryBadRequest.php
View File

@@ -9,16 +9,16 @@ declare(strict_types=1);
namespace LukeHagar\Plex_API\Models\Errors;
use LukeHagar\Plex_API\Utils;
/** GetMetaDataByRatingKeyBadRequest - Bad Request - A parameter was not specified, or was specified incorrectly. */
class GetMetaDataByRatingKeyBadRequest
/** GetActorsLibraryBadRequest - Bad Request - A parameter was not specified, or was specified incorrectly. */
class GetActorsLibraryBadRequest
{
/**
* $errors
*
* @var ?array<GetMetaDataByRatingKeyErrors> $errors
* @var ?array<GetActorsLibraryErrors> $errors
*/
#[\Speakeasy\Serializer\Annotation\SerializedName('errors')]
#[\Speakeasy\Serializer\Annotation\Type('array<\LukeHagar\Plex_API\Models\Errors\GetMetaDataByRatingKeyErrors>|null')]
#[\Speakeasy\Serializer\Annotation\Type('array<\LukeHagar\Plex_API\Models\Errors\GetActorsLibraryErrors>|null')]
#[\Speakeasy\Serializer\Annotation\SkipWhenNull]
public ?array $errors = null;
@@ -32,7 +32,7 @@ class GetMetaDataByRatingKeyBadRequest
public ?\Psr\Http\Message\ResponseInterface $rawResponse = null;
/**
* @param ?array<GetMetaDataByRatingKeyErrors> $errors
* @param ?array<GetActorsLibraryErrors> $errors
* @param ?\Psr\Http\Message\ResponseInterface $rawResponse
* @phpstan-pure
*/
@@ -42,12 +42,12 @@ class GetMetaDataByRatingKeyBadRequest
$this->rawResponse = $rawResponse;
}
public function toException(): GetMetaDataByRatingKeyBadRequestThrowable
public function toException(): GetActorsLibraryBadRequestThrowable
{
$serializer = Utils\JSON::createSerializer();
$message = $serializer->serialize($this, 'json');
$code = -1;
return new GetMetaDataByRatingKeyBadRequestThrowable($message, (int) $code, $this);
return new GetActorsLibraryBadRequestThrowable($message, (int) $code, $this);
}
}

6
src/Models/Errors/GetMetaDataByRatingKeyBadRequestThrowable.php → src/Models/Errors/GetActorsLibraryBadRequestThrowable.php
View File

@@ -8,11 +8,11 @@ declare(strict_types=1);
namespace LukeHagar\Plex_API\Models\Errors;
class GetMetaDataByRatingKeyBadRequestThrowable extends \RuntimeException
class GetActorsLibraryBadRequestThrowable extends \RuntimeException
{
public GetMetaDataByRatingKeyBadRequest $container;
public GetActorsLibraryBadRequest $container;
public function __construct(string $message, int $statusCode, GetMetaDataByRatingKeyBadRequest $container)
public function __construct(string $message, int $statusCode, GetActorsLibraryBadRequest $container)
{
parent::__construct($message, $statusCode);
$this->container = $container;

2
src/Models/Errors/GetMetaDataByRatingKeyErrors.php → src/Models/Errors/GetActorsLibraryErrors.php
View File

@@ -9,7 +9,7 @@ declare(strict_types=1);
namespace LukeHagar\Plex_API\Models\Errors;
class GetMetaDataByRatingKeyErrors
class GetActorsLibraryErrors
{
/**
*

2
src/Models/Errors/GetMetaDataByRatingKeyLibraryErrors.php → src/Models/Errors/GetActorsLibraryLibraryErrors.php
View File

@@ -9,7 +9,7 @@ declare(strict_types=1);
namespace LukeHagar\Plex_API\Models\Errors;
class GetMetaDataByRatingKeyLibraryErrors
class GetActorsLibraryLibraryErrors
{
/**
*

14
src/Models/Errors/GetMetaDataByRatingKeyUnauthorized.php → src/Models/Errors/GetActorsLibraryUnauthorized.php
View File

@@ -9,16 +9,16 @@ declare(strict_types=1);
namespace LukeHagar\Plex_API\Models\Errors;
use LukeHagar\Plex_API\Utils;
/** GetMetaDataByRatingKeyUnauthorized - Unauthorized - Returned if the X-Plex-Token is missing from the header or query. */
class GetMetaDataByRatingKeyUnauthorized
/** GetActorsLibraryUnauthorized - Unauthorized - Returned if the X-Plex-Token is missing from the header or query. */
class GetActorsLibraryUnauthorized
{
/**
* $errors
*
* @var ?array<GetMetaDataByRatingKeyLibraryErrors> $errors
* @var ?array<GetActorsLibraryLibraryErrors> $errors
*/
#[\Speakeasy\Serializer\Annotation\SerializedName('errors')]
#[\Speakeasy\Serializer\Annotation\Type('array<\LukeHagar\Plex_API\Models\Errors\GetMetaDataByRatingKeyLibraryErrors>|null')]
#[\Speakeasy\Serializer\Annotation\Type('array<\LukeHagar\Plex_API\Models\Errors\GetActorsLibraryLibraryErrors>|null')]
#[\Speakeasy\Serializer\Annotation\SkipWhenNull]
public ?array $errors = null;
@@ -32,7 +32,7 @@ class GetMetaDataByRatingKeyUnauthorized
public ?\Psr\Http\Message\ResponseInterface $rawResponse = null;
/**
* @param ?array<GetMetaDataByRatingKeyLibraryErrors> $errors
* @param ?array<GetActorsLibraryLibraryErrors> $errors
* @param ?\Psr\Http\Message\ResponseInterface $rawResponse
* @phpstan-pure
*/
@@ -42,12 +42,12 @@ class GetMetaDataByRatingKeyUnauthorized
$this->rawResponse = $rawResponse;
}
public function toException(): GetMetaDataByRatingKeyUnauthorizedThrowable
public function toException(): GetActorsLibraryUnauthorizedThrowable
{
$serializer = Utils\JSON::createSerializer();
$message = $serializer->serialize($this, 'json');
$code = -1;
return new GetMetaDataByRatingKeyUnauthorizedThrowable($message, (int) $code, $this);
return new GetActorsLibraryUnauthorizedThrowable($message, (int) $code, $this);
}
}

6
src/Models/Errors/GetMetaDataByRatingKeyUnauthorizedThrowable.php → src/Models/Errors/GetActorsLibraryUnauthorizedThrowable.php
View File

@@ -8,11 +8,11 @@ declare(strict_types=1);
namespace LukeHagar\Plex_API\Models\Errors;
class GetMetaDataByRatingKeyUnauthorizedThrowable extends \RuntimeException
class GetActorsLibraryUnauthorizedThrowable extends \RuntimeException
{
public GetMetaDataByRatingKeyUnauthorized $container;
public GetActorsLibraryUnauthorized $container;
public function __construct(string $message, int $statusCode, GetMetaDataByRatingKeyUnauthorized $container)
public function __construct(string $message, int $statusCode, GetActorsLibraryUnauthorized $container)
{
parent::__construct($message, $statusCode);
$this->container = $container;

53
src/Models/Errors/GetMediaMetaDataBadRequest.php Normal file
View File

@@ -0,0 +1,53 @@
<?php
/**
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
*/
declare(strict_types=1);
namespace LukeHagar\Plex_API\Models\Errors;
use LukeHagar\Plex_API\Utils;
/** GetMediaMetaDataBadRequest - Bad Request - A parameter was not specified, or was specified incorrectly. */
class GetMediaMetaDataBadRequest
{
/**
* $errors
*
* @var ?array<GetMediaMetaDataErrors> $errors
*/
#[\Speakeasy\Serializer\Annotation\SerializedName('errors')]
#[\Speakeasy\Serializer\Annotation\Type('array<\LukeHagar\Plex_API\Models\Errors\GetMediaMetaDataErrors>|null')]
#[\Speakeasy\Serializer\Annotation\SkipWhenNull]
public ?array $errors = null;
/**
* Raw HTTP response; suitable for custom response parsing
*
* @var ?\Psr\Http\Message\ResponseInterface $rawResponse
*/
#[\Speakeasy\Serializer\Annotation\Exclude]
public ?\Psr\Http\Message\ResponseInterface $rawResponse = null;
/**
* @param ?array<GetMediaMetaDataErrors> $errors
* @param ?\Psr\Http\Message\ResponseInterface $rawResponse
* @phpstan-pure
*/
public function __construct(?array $errors = null, ?\Psr\Http\Message\ResponseInterface $rawResponse = null)
{
$this->errors = $errors;
$this->rawResponse = $rawResponse;
}
public function toException(): GetMediaMetaDataBadRequestThrowable
{
$serializer = Utils\JSON::createSerializer();
$message = $serializer->serialize($this, 'json');
$code = -1;
return new GetMediaMetaDataBadRequestThrowable($message, (int) $code, $this);
}
}

20
src/Models/Errors/GetMediaMetaDataBadRequestThrowable.php Normal file
View File

@@ -0,0 +1,20 @@
<?php
/**
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
*/
declare(strict_types=1);
namespace LukeHagar\Plex_API\Models\Errors;
class GetMediaMetaDataBadRequestThrowable extends \RuntimeException
{
public GetMediaMetaDataBadRequest $container;
public function __construct(string $message, int $statusCode, GetMediaMetaDataBadRequest $container)
{
parent::__construct($message, $statusCode);
$this->container = $container;
}
}

50
src/Models/Errors/GetMediaMetaDataErrors.php Normal file
View File

@@ -0,0 +1,50 @@
<?php
/**
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
*/
declare(strict_types=1);
namespace LukeHagar\Plex_API\Models\Errors;
class GetMediaMetaDataErrors
{
/**
*
* @var ?int $code
*/
#[\Speakeasy\Serializer\Annotation\SerializedName('code')]
#[\Speakeasy\Serializer\Annotation\SkipWhenNull]
public ?int $code = null;
/**
*
* @var ?string $message
*/
#[\Speakeasy\Serializer\Annotation\SerializedName('message')]
#[\Speakeasy\Serializer\Annotation\SkipWhenNull]
public ?string $message = null;
/**
*
* @var ?int $status
*/
#[\Speakeasy\Serializer\Annotation\SerializedName('status')]
#[\Speakeasy\Serializer\Annotation\SkipWhenNull]
public ?int $status = null;
/**
* @param ?int $code
* @param ?string $message
* @param ?int $status
* @phpstan-pure
*/
public function __construct(?int $code = null, ?string $message = null, ?int $status = null)
{
$this->code = $code;
$this->message = $message;
$this->status = $status;
}
}

50
src/Models/Errors/GetMediaMetaDataLibraryErrors.php Normal file
View File

@@ -0,0 +1,50 @@
<?php
/**
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
*/
declare(strict_types=1);
namespace LukeHagar\Plex_API\Models\Errors;
class GetMediaMetaDataLibraryErrors
{
/**
*
* @var ?int $code
*/
#[\Speakeasy\Serializer\Annotation\SerializedName('code')]
#[\Speakeasy\Serializer\Annotation\SkipWhenNull]
public ?int $code = null;
/**
*
* @var ?string $message
*/
#[\Speakeasy\Serializer\Annotation\SerializedName('message')]
#[\Speakeasy\Serializer\Annotation\SkipWhenNull]
public ?string $message = null;
/**
*
* @var ?int $status
*/
#[\Speakeasy\Serializer\Annotation\SerializedName('status')]
#[\Speakeasy\Serializer\Annotation\SkipWhenNull]
public ?int $status = null;
/**
* @param ?int $code
* @param ?string $message
* @param ?int $status
* @phpstan-pure
*/
public function __construct(?int $code = null, ?string $message = null, ?int $status = null)
{
$this->code = $code;
$this->message = $message;
$this->status = $status;
}
}

53
src/Models/Errors/GetMediaMetaDataUnauthorized.php Normal file
View File

@@ -0,0 +1,53 @@
<?php
/**
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
*/
declare(strict_types=1);
namespace LukeHagar\Plex_API\Models\Errors;
use LukeHagar\Plex_API\Utils;
/** GetMediaMetaDataUnauthorized - Unauthorized - Returned if the X-Plex-Token is missing from the header or query. */
class GetMediaMetaDataUnauthorized
{
/**
* $errors
*
* @var ?array<GetMediaMetaDataLibraryErrors> $errors
*/
#[\Speakeasy\Serializer\Annotation\SerializedName('errors')]
#[\Speakeasy\Serializer\Annotation\Type('array<\LukeHagar\Plex_API\Models\Errors\GetMediaMetaDataLibraryErrors>|null')]
#[\Speakeasy\Serializer\Annotation\SkipWhenNull]
public ?array $errors = null;
/**
* Raw HTTP response; suitable for custom response parsing
*
* @var ?\Psr\Http\Message\ResponseInterface $rawResponse
*/
#[\Speakeasy\Serializer\Annotation\Exclude]
public ?\Psr\Http\Message\ResponseInterface $rawResponse = null;
/**
* @param ?array<GetMediaMetaDataLibraryErrors> $errors
* @param ?\Psr\Http\Message\ResponseInterface $rawResponse
* @phpstan-pure
*/
public function __construct(?array $errors = null, ?\Psr\Http\Message\ResponseInterface $rawResponse = null)
{
$this->errors = $errors;
$this->rawResponse = $rawResponse;
}
public function toException(): GetMediaMetaDataUnauthorizedThrowable
{
$serializer = Utils\JSON::createSerializer();
$message = $serializer->serialize($this, 'json');
$code = -1;
return new GetMediaMetaDataUnauthorizedThrowable($message, (int) $code, $this);
}
}

20
src/Models/Errors/GetMediaMetaDataUnauthorizedThrowable.php Normal file
View File

@@ -0,0 +1,20 @@
<?php
/**
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
*/
declare(strict_types=1);
namespace LukeHagar\Plex_API\Models\Errors;
class GetMediaMetaDataUnauthorizedThrowable extends \RuntimeException
{
public GetMediaMetaDataUnauthorized $container;
public function __construct(string $message, int $statusCode, GetMediaMetaDataUnauthorized $container)
{
parent::__construct($message, $statusCode);
$this->container = $container;
}
}

60
src/Models/Operations/GetActorsLibraryDirectory.php Normal file
View File

@@ -0,0 +1,60 @@
<?php
/**
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
*/
declare(strict_types=1);
namespace LukeHagar\Plex_API\Models\Operations;
class GetActorsLibraryDirectory
{
/**
* A fast lookup key for the actor relative url.
*
* @var string $fastKey
*/
#[\Speakeasy\Serializer\Annotation\SerializedName('fastKey')]
public string $fastKey;
/**
* URL for the thumbnail image of the actor.
*
* @var string $thumb
*/
#[\Speakeasy\Serializer\Annotation\SerializedName('thumb')]
public string $thumb;
/**
* A unique key representing the actor.
*
* @var string $key
*/
#[\Speakeasy\Serializer\Annotation\SerializedName('key')]
public string $key;
/**
* The name of the actor.
*
* @var string $title
*/
#[\Speakeasy\Serializer\Annotation\SerializedName('title')]
public string $title;
/**
* @param string $fastKey
* @param string $thumb
* @param string $key
* @param string $title
* @phpstan-pure
*/
public function __construct(string $fastKey, string $thumb, string $key, string $title)
{
$this->fastKey = $fastKey;
$this->thumb = $thumb;
$this->key = $key;
$this->title = $title;
}
}

151
src/Models/Operations/GetActorsLibraryMediaContainer.php Normal file
View File

@@ -0,0 +1,151 @@
<?php
/**
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
*/
declare(strict_types=1);
namespace LukeHagar\Plex_API\Models\Operations;
class GetActorsLibraryMediaContainer
{
/**
*
* @var float $size
*/
#[\Speakeasy\Serializer\Annotation\SerializedName('size')]
public float $size;
/**
* Indicates whether syncing is allowed.
*
* @var bool $allowSync
*/
#[\Speakeasy\Serializer\Annotation\SerializedName('allowSync')]
public bool $allowSync;
/**
* URL for the background artwork of the media container.
*
* @var string $art
*/
#[\Speakeasy\Serializer\Annotation\SerializedName('art')]
public string $art;
/**
* An plugin identifier for the media container.
*
* @var string $identifier
*/
#[\Speakeasy\Serializer\Annotation\SerializedName('identifier')]
public string $identifier;
/**
* The prefix used for media tag resource paths.
*
* @var string $mediaTagPrefix
*/
#[\Speakeasy\Serializer\Annotation\SerializedName('mediaTagPrefix')]
public string $mediaTagPrefix;
/**
* The version number for media tags.
*
* @var int $mediaTagVersion
*/
#[\Speakeasy\Serializer\Annotation\SerializedName('mediaTagVersion')]
public int $mediaTagVersion;
/**
* Specifies whether caching is disabled.
*
* @var bool $nocache
*/
#[\Speakeasy\Serializer\Annotation\SerializedName('nocache')]
public bool $nocache;
/**
* URL for the thumbnail image of the media container.
*
* @var string $thumb
*/
#[\Speakeasy\Serializer\Annotation\SerializedName('thumb')]
public string $thumb;
/**
* The primary title of the media container.
*
* @var string $title1
*/
#[\Speakeasy\Serializer\Annotation\SerializedName('title1')]
public string $title1;
/**
* The secondary title of the media container.
*
* @var string $title2
*/
#[\Speakeasy\Serializer\Annotation\SerializedName('title2')]
public string $title2;
/**
* Identifier for the view group layout.
*
* @var string $viewGroup
*/
#[\Speakeasy\Serializer\Annotation\SerializedName('viewGroup')]
public string $viewGroup;
/**
* Identifier for the view mode.
*
* @var string $viewMode
*/
#[\Speakeasy\Serializer\Annotation\SerializedName('viewMode')]
public string $viewMode;
/**
* An array of actor entries for media items.
*
* @var ?array<GetActorsLibraryDirectory> $directory
*/
#[\Speakeasy\Serializer\Annotation\SerializedName('Directory')]
#[\Speakeasy\Serializer\Annotation\Type('array<\LukeHagar\Plex_API\Models\Operations\GetActorsLibraryDirectory>|null')]
#[\Speakeasy\Serializer\Annotation\SkipWhenNull]
public ?array $directory = null;
/**
* @param float $size
* @param bool $allowSync
* @param string $art
* @param string $identifier
* @param string $mediaTagPrefix
* @param int $mediaTagVersion
* @param bool $nocache
* @param string $thumb
* @param string $title1
* @param string $title2
* @param string $viewGroup
* @param string $viewMode
* @param ?array<GetActorsLibraryDirectory> $directory
* @phpstan-pure
*/
public function __construct(float $size, bool $allowSync, string $art, string $identifier, string $mediaTagPrefix, int $mediaTagVersion, bool $nocache, string $thumb, string $title1, string $title2, string $viewGroup, string $viewMode, ?array $directory = null)
{
$this->size = $size;
$this->allowSync = $allowSync;
$this->art = $art;
$this->identifier = $identifier;
$this->mediaTagPrefix = $mediaTagPrefix;
$this->mediaTagVersion = $mediaTagVersion;
$this->nocache = $nocache;
$this->thumb = $thumb;
$this->title1 = $title1;
$this->title2 = $title2;
$this->viewGroup = $viewGroup;
$this->viewMode = $viewMode;
$this->directory = $directory;
}
}

31
src/Models/Operations/GetActorsLibraryQueryParamType.php Normal file
View File

@@ -0,0 +1,31 @@
<?php
/**
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
*/
declare(strict_types=1);
namespace LukeHagar\Plex_API\Models\Operations;
/**
* The type of media to retrieve or filter by.
*
* 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
*
*/
enum GetActorsLibraryQueryParamType: int
{
case Movie = 1;
case TvShow = 2;
case Season = 3;
case Episode = 4;
case Audio = 8;
case Album = 9;
case Track = 10;
}

50
src/Models/Operations/GetActorsLibraryRequest.php Normal file
View File

@@ -0,0 +1,50 @@
<?php
/**
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
*/
declare(strict_types=1);
namespace LukeHagar\Plex_API\Models\Operations;
use LukeHagar\Plex_API\Utils\SpeakeasyMetadata;
class GetActorsLibraryRequest
{
/**
* The unique key of the Plex library.
*
* Note: This is unique in the context of the Plex server.
*
*
* @var int $sectionKey
*/
#[SpeakeasyMetadata('pathParam:style=simple,explode=false,name=sectionKey')]
public int $sectionKey;
/**
* The type of media to retrieve or filter by.
*
* 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
*
*
* @var GetActorsLibraryQueryParamType $type
*/
#[SpeakeasyMetadata('queryParam:style=form,explode=true,name=type')]
public GetActorsLibraryQueryParamType $type;
/**
* @param int $sectionKey
* @param GetActorsLibraryQueryParamType $type
* @phpstan-pure
*/
public function __construct(int $sectionKey, GetActorsLibraryQueryParamType $type)
{
$this->sectionKey = $sectionKey;
$this->type = $type;
}
}

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

@@ -0,0 +1,56 @@
<?php
/**
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
*/
declare(strict_types=1);
namespace LukeHagar\Plex_API\Models\Operations;
class GetActorsLibraryResponse
{
/**
* HTTP response content type for this operation
*
* @var string $contentType
*/
public string $contentType;
/**
* HTTP response status code for this operation
*
* @var int $statusCode
*/
public int $statusCode;
/**
* Raw HTTP response; suitable for custom response parsing
*
* @var \Psr\Http\Message\ResponseInterface $rawResponse
*/
public \Psr\Http\Message\ResponseInterface $rawResponse;
/**
* Successful response containing media container data.
*
* @var ?GetActorsLibraryResponseBody $object
*/
public ?GetActorsLibraryResponseBody $object = null;
/**
* @param string $contentType
* @param int $statusCode
* @param \Psr\Http\Message\ResponseInterface $rawResponse
* @param ?GetActorsLibraryResponseBody $object
* @phpstan-pure
*/
public function __construct(string $contentType, int $statusCode, \Psr\Http\Message\ResponseInterface $rawResponse, ?GetActorsLibraryResponseBody $object = null)
{
$this->contentType = $contentType;
$this->statusCode = $statusCode;
$this->rawResponse = $rawResponse;
$this->object = $object;
}
}

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

@@ -0,0 +1,32 @@
<?php
/**
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
*/
declare(strict_types=1);
namespace LukeHagar\Plex_API\Models\Operations;
/** GetActorsLibraryResponseBody - Successful response containing media container data. */
class GetActorsLibraryResponseBody
{
/**
*
* @var ?GetActorsLibraryMediaContainer $mediaContainer
*/
#[\Speakeasy\Serializer\Annotation\SerializedName('MediaContainer')]
#[\Speakeasy\Serializer\Annotation\Type('\LukeHagar\Plex_API\Models\Operations\GetActorsLibraryMediaContainer|null')]
#[\Speakeasy\Serializer\Annotation\SkipWhenNull]
public ?GetActorsLibraryMediaContainer $mediaContainer = null;
/**
* @param ?GetActorsLibraryMediaContainer $mediaContainer
* @phpstan-pure
*/
public function __construct(?GetActorsLibraryMediaContainer $mediaContainer = null)
{
$this->mediaContainer = $mediaContainer;
}
}

31
src/Models/Operations/GetCountriesLibraryQueryParamType.php Normal file
View File

@@ -0,0 +1,31 @@
<?php
/**
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
*/
declare(strict_types=1);
namespace LukeHagar\Plex_API\Models\Operations;
/**
* The type of media to retrieve or filter by.
*
* 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
*
*/
enum GetCountriesLibraryQueryParamType: int
{
case Movie = 1;
case TvShow = 2;
case Season = 3;
case Episode = 4;
case Audio = 8;
case Album = 9;
case Track = 10;
}

19
src/Models/Operations/GetCountriesLibraryRequest.php
View File

@@ -22,12 +22,29 @@ class GetCountriesLibraryRequest
#[SpeakeasyMetadata('pathParam:style=simple,explode=false,name=sectionKey')]
public int $sectionKey;
/**
* The type of media to retrieve or filter by.
*
* 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
*
*
* @var GetCountriesLibraryQueryParamType $type
*/
#[SpeakeasyMetadata('queryParam:style=form,explode=true,name=type')]
public GetCountriesLibraryQueryParamType $type;
/**
* @param int $sectionKey
* @param GetCountriesLibraryQueryParamType $type
* @phpstan-pure
*/
public function __construct(int $sectionKey)
public function __construct(int $sectionKey, GetCountriesLibraryQueryParamType $type)
{
$this->sectionKey = $sectionKey;
$this->type = $type;
}
}

31
src/Models/Operations/GetGenresLibraryQueryParamType.php Normal file
View File

@@ -0,0 +1,31 @@
<?php
/**
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
*/
declare(strict_types=1);
namespace LukeHagar\Plex_API\Models\Operations;
/**
* The type of media to retrieve or filter by.
*
* 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
*
*/
enum GetGenresLibraryQueryParamType: int
{
case Movie = 1;
case TvShow = 2;
case Season = 3;
case Episode = 4;
case Audio = 8;
case Album = 9;
case Track = 10;
}

19
src/Models/Operations/GetGenresLibraryRequest.php
View File

@@ -22,12 +22,29 @@ class GetGenresLibraryRequest
#[SpeakeasyMetadata('pathParam:style=simple,explode=false,name=sectionKey')]
public int $sectionKey;
/**
* The type of media to retrieve or filter by.
*
* 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
*
*
* @var GetGenresLibraryQueryParamType $type
*/
#[SpeakeasyMetadata('queryParam:style=form,explode=true,name=type')]
public GetGenresLibraryQueryParamType $type;
/**
* @param int $sectionKey
* @param GetGenresLibraryQueryParamType $type
* @phpstan-pure
*/
public function __construct(int $sectionKey)
public function __construct(int $sectionKey, GetGenresLibraryQueryParamType $type)
{
$this->sectionKey = $sectionKey;
$this->type = $type;
}
}

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

@@ -10,7 +10,7 @@ namespace LukeHagar\Plex_API\Models\Operations;
/**
* The type of media to retrieve.
* The type of media to retrieve or filter by.
*
* 1 = movie
* 2 = show

36
src/Models/Operations/GetLibraryItemsRequest.php
View File

@@ -19,6 +19,21 @@ class GetLibraryItemsRequest
#[SpeakeasyMetadata('pathParam:style=simple,explode=false,name=tag')]
public Tag $tag;
/**
* The type of media to retrieve or filter by.
*
* 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
*
*
* @var GetLibraryItemsQueryParamType $type
*/
#[SpeakeasyMetadata('queryParam:style=form,explode=true,name=type')]
public GetLibraryItemsQueryParamType $type;
/**
* The unique key of the Plex library.
*
@@ -30,21 +45,6 @@ class GetLibraryItemsRequest
#[SpeakeasyMetadata('pathParam:style=simple,explode=false,name=sectionKey')]
public int $sectionKey;
/**
* 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
*
*
* @var ?GetLibraryItemsQueryParamType $type
*/
#[SpeakeasyMetadata('queryParam:style=form,explode=true,name=type')]
public ?GetLibraryItemsQueryParamType $type = null;
/**
* Adds the Guids object to the response
*
@@ -91,19 +91,19 @@ class GetLibraryItemsRequest
/**
* @param Tag $tag
* @param GetLibraryItemsQueryParamType $type
* @param int $sectionKey
* @param ?IncludeGuids $includeGuids
* @param ?GetLibraryItemsQueryParamType $type
* @param ?GetLibraryItemsQueryParamIncludeMeta $includeMeta
* @param ?int $xPlexContainerStart
* @param ?int $xPlexContainerSize
* @phpstan-pure
*/
public function __construct(Tag $tag, int $sectionKey, ?GetLibraryItemsQueryParamType $type = null, ?IncludeGuids $includeGuids = IncludeGuids::Disable, ?GetLibraryItemsQueryParamIncludeMeta $includeMeta = GetLibraryItemsQueryParamIncludeMeta::Disable, ?int $xPlexContainerStart = 0, ?int $xPlexContainerSize = 50)
public function __construct(Tag $tag, GetLibraryItemsQueryParamType $type, int $sectionKey, ?IncludeGuids $includeGuids = IncludeGuids::Disable, ?GetLibraryItemsQueryParamIncludeMeta $includeMeta = GetLibraryItemsQueryParamIncludeMeta::Disable, ?int $xPlexContainerStart = 0, ?int $xPlexContainerSize = 50)
{
$this->tag = $tag;
$this->sectionKey = $sectionKey;
$this->type = $type;
$this->sectionKey = $sectionKey;
$this->includeGuids = $includeGuids;
$this->includeMeta = $includeMeta;
$this->xPlexContainerStart = $xPlexContainerStart;

28
src/Models/Operations/GetMetaDataByRatingKeyGenre.php → src/Models/Operations/GetMediaMetaDataCountry.php
View File

@@ -9,39 +9,39 @@ declare(strict_types=1);
namespace LukeHagar\Plex_API\Models\Operations;
class GetMetaDataByRatingKeyGenre
class GetMediaMetaDataCountry
{
/**
* The unique country identifier.
*
* @var ?int $id
* @var int $id
*/
#[\Speakeasy\Serializer\Annotation\SerializedName('id')]
#[\Speakeasy\Serializer\Annotation\SkipWhenNull]
public ?int $id = null;
public int $id;
/**
* The filter string for the country.
*
* @var ?string $filter
* @var string $filter
*/
#[\Speakeasy\Serializer\Annotation\SerializedName('filter')]
#[\Speakeasy\Serializer\Annotation\SkipWhenNull]
public ?string $filter = null;
public string $filter;
/**
* The country name.
*
* @var ?string $tag
* @var string $tag
*/
#[\Speakeasy\Serializer\Annotation\SerializedName('tag')]
#[\Speakeasy\Serializer\Annotation\SkipWhenNull]
public ?string $tag = null;
public string $tag;
/**
* @param ?int $id
* @param ?string $filter
* @param ?string $tag
* @param int $id
* @param string $filter
* @param string $tag
* @phpstan-pure
*/
public function __construct(?int $id = null, ?string $filter = null, ?string $tag = null)
public function __construct(int $id, string $filter, string $tag)
{
$this->id = $id;
$this->filter = $filter;

38
src/Models/Operations/GetMetaDataByRatingKeyRole.php → src/Models/Operations/GetMediaMetaDataDirector.php
View File

@@ -9,41 +9,42 @@ declare(strict_types=1);
namespace LukeHagar\Plex_API\Models\Operations;
class GetMetaDataByRatingKeyRole
class GetMediaMetaDataDirector
{
/**
* The unique role identifier.
*
* @var ?int $id
* @var int $id
*/
#[\Speakeasy\Serializer\Annotation\SerializedName('id')]
#[\Speakeasy\Serializer\Annotation\SkipWhenNull]
public ?int $id = null;
public int $id;
/**
* The filter string for the role.
*
* @var ?string $filter
* @var string $filter
*/
#[\Speakeasy\Serializer\Annotation\SerializedName('filter')]
#[\Speakeasy\Serializer\Annotation\SkipWhenNull]
public ?string $filter = null;
public string $filter;
/**
* The actor's name.
*
* @var ?string $tag
* @var string $tag
*/
#[\Speakeasy\Serializer\Annotation\SerializedName('tag')]
#[\Speakeasy\Serializer\Annotation\SkipWhenNull]
public ?string $tag = null;
public string $tag;
/**
* A key associated with the actor tag.
*
* @var ?string $tagKey
* @var string $tagKey
*/
#[\Speakeasy\Serializer\Annotation\SerializedName('tagKey')]
#[\Speakeasy\Serializer\Annotation\SkipWhenNull]
public ?string $tagKey = null;
public string $tagKey;
/**
* The character name or role.
*
* @var ?string $role
*/
@@ -52,6 +53,7 @@ class GetMetaDataByRatingKeyRole
public ?string $role = null;
/**
* URL for the role thumbnail image.
*
* @var ?string $thumb
*/
@@ -60,15 +62,15 @@ class GetMetaDataByRatingKeyRole
public ?string $thumb = null;
/**
* @param ?int $id
* @param ?string $filter
* @param ?string $tag
* @param ?string $tagKey
* @param int $id
* @param string $filter
* @param string $tag
* @param string $tagKey
* @param ?string $role
* @param ?string $thumb
* @phpstan-pure
*/
public function __construct(?int $id = null, ?string $filter = null, ?string $tag = null, ?string $tagKey = null, ?string $role = null, ?string $thumb = null)
public function __construct(int $id, string $filter, string $tag, string $tagKey, ?string $role = null, ?string $thumb = null)
{
$this->id = $id;
$this->filter = $filter;

28
src/Models/Operations/GetMetaDataByRatingKeyCountry.php → src/Models/Operations/GetMediaMetaDataGenre.php
View File

@@ -9,39 +9,39 @@ declare(strict_types=1);
namespace LukeHagar\Plex_API\Models\Operations;
class GetMetaDataByRatingKeyCountry
class GetMediaMetaDataGenre
{
/**
* The unique genre identifier.
*
* @var ?int $id
* @var int $id
*/
#[\Speakeasy\Serializer\Annotation\SerializedName('id')]
#[\Speakeasy\Serializer\Annotation\SkipWhenNull]
public ?int $id = null;
public int $id;
/**
* The filter string for the genre.
*
* @var ?string $filter
* @var string $filter
*/
#[\Speakeasy\Serializer\Annotation\SerializedName('filter')]
#[\Speakeasy\Serializer\Annotation\SkipWhenNull]
public ?string $filter = null;
public string $filter;
/**
* The genre name.
*
* @var ?string $tag
* @var string $tag
*/
#[\Speakeasy\Serializer\Annotation\SerializedName('tag')]
#[\Speakeasy\Serializer\Annotation\SkipWhenNull]
public ?string $tag = null;
public string $tag;
/**
* @param ?int $id
* @param ?string $filter
* @param ?string $tag
* @param int $id
* @param string $filter
* @param string $tag
* @phpstan-pure
*/
public function __construct(?int $id = null, ?string $filter = null, ?string $tag = null)
public function __construct(int $id, string $filter, string $tag)
{
$this->id = $id;
$this->filter = $filter;

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