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

Browse Source
This commit is contained in:
speakeasybot
2025-02-11 00:11:32 +00:00
parent d833e675dd
commit e95c490be0
151 changed files with 5128 additions and 454 deletions
Download Patch File Download Diff File Expand all files Collapse all files

140
.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.8
version: 0.13.0
additionalDependencies:
autoload: {}
autoload-dev: {}

14
.speakeasy/workflow.lock
View File

@@ -1,4 +1,4 @@
speakeasyVersion: 1.487.1
speakeasyVersion: 1.488.0
sources:
my-source:
sourceNamespace: my-source
@@ -9,19 +9,19 @@ sources:
- main
plexapi:
sourceNamespace: plexapi
sourceRevisionDigest: sha256:49536684a97842ea7c069f909012b31a22a046d8277aee47b50a334494bf2c64
sourceBlobDigest: sha256:eac671ea32ce31e1e558839153f7effef39bb35b4e461c6e95661d0eaf4ce1c8
sourceRevisionDigest: sha256:0efb9039972533bf1190dfc1ffb377429a8e486b6299442e732f662c1ffbeca6
sourceBlobDigest: sha256:038d73166cc9db17f514d511cfe4365ea032f4ebcb247fa86b7aa1bba0e1ab46
tags:
- latest
- speakeasy-sdk-regen-1738973394
- speakeasy-sdk-regen-1739232598
targets:
plexphp:
source: plexapi
sourceNamespace: plexapi
sourceRevisionDigest: sha256:49536684a97842ea7c069f909012b31a22a046d8277aee47b50a334494bf2c64
sourceBlobDigest: sha256:eac671ea32ce31e1e558839153f7effef39bb35b4e461c6e95661d0eaf4ce1c8
sourceRevisionDigest: sha256:0efb9039972533bf1190dfc1ffb377429a8e486b6299442e732f662c1ffbeca6
sourceBlobDigest: sha256:038d73166cc9db17f514d511cfe4365ea032f4ebcb247fa86b7aa1bba0e1ab46
codeSamplesNamespace: code-samples-php-plexphp
codeSamplesRevisionDigest: sha256:42ec46311046c3e98c773d65c3c11a6c74c7e0c5e5fb37f1b6fa3427ca45ad83
codeSamplesRevisionDigest: sha256:4ae9cce8da28704069c8a76f17d68fc0cd960200a362d8b4b8f7ac686242248a
workflow:
workflowVersion: 1.0.0
speakeasyVersion: latest

1
README.md
View File

@@ -172,6 +172,7 @@ if ($response->object !== null) {
* [deleteLibrary](docs/sdks/library/README.md#deletelibrary) - Delete Library Section
* [getActorsLibrary](docs/sdks/library/README.md#getactorslibrary) - Get Actors of library media
* [getAllLibraries](docs/sdks/library/README.md#getalllibraries) - Get All Libraries
* [getAllMediaLibrary](docs/sdks/library/README.md#getallmedialibrary) - Get all media of library
* [getCountriesLibrary](docs/sdks/library/README.md#getcountrieslibrary) - Get Countries of library media
* [getGenresLibrary](docs/sdks/library/README.md#getgenreslibrary) - Get Genres of library media
* [getLibraryDetails](docs/sdks/library/README.md#getlibrarydetails) - Get Library Details

12
RELEASES.md
View File

@@ -782,4 +782,14 @@ Based on:
### Generated
- [php v0.12.8] .
### Releases
- [Composer v0.12.8] https://packagist.org/packages/lukehagar/plex-api#v0.12.8 - .
- [Composer v0.12.8] https://packagist.org/packages/lukehagar/plex-api#v0.12.8 - .
## 2025-02-11 00:09:43
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.488.0 (2.506.0) https://github.com/speakeasy-api/speakeasy
### Generated
- [php v0.13.0] .
### Releases
- [Composer v0.13.0] https://packagist.org/packages/lukehagar/plex-api#v0.13.0 - .

31
codeSamples.yaml
View File

@@ -1155,6 +1155,37 @@ actions:
);
if ($response->object !== null) {
// handle response
}
- target: $["paths"]["/library/sections/{sectionKey}/all"]["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();
$request = new Operations\GetAllMediaLibraryRequest(
sectionKey: 9518,
type: Operations\GetAllMediaLibraryQueryParamType::TvShow,
);
$response = $sdk->library->getAllMediaLibrary(
request: $request
);
if ($response->object !== null) {
// handle response
}

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

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

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

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

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

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

@@ -5,7 +5,7 @@
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
| `size` | *float* | :heavy_check_mark: | N/A | 50 |
| `size` | *int* | :heavy_check_mark: | Number of media items returned in this response. | 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 |

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

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

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

@@ -0,0 +1,8 @@
# GetAllMediaLibraryCollection
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- |
| `tag` | *string* | :heavy_check_mark: | The user-made collection this media item belongs to | My Awesome Collection |

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

@@ -0,0 +1,8 @@
# GetAllMediaLibraryCountry
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
| `tag` | *string* | :heavy_check_mark: | The country of origin of this media item | United States of America |

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

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

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

@@ -0,0 +1,8 @@
# GetAllMediaLibraryDirector
## Fields
| Field | Type | Required | Description | Example |
| -------------------- | -------------------- | -------------------- | -------------------- | -------------------- |
| `tag` | *string* | :heavy_check_mark: | The role of Director | Danny Boyle |

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

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

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

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

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

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

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

@@ -0,0 +1,8 @@
# GetAllMediaLibraryGenre
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
| `tag` | *string* | :heavy_check_mark: | The country of origin of this media item | United States of America |

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

@@ -0,0 +1,11 @@
# GetAllMediaLibraryHasThumbnail
Indicates if the part has a thumbnail.
## Values
| Name | Value |
| ------- | ------- |
| `False` | 0 |
| `True` | 1 |

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

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

25
docs/Models/Operations/GetAllMediaLibraryLibraryOptimizedForStreaming.md Normal file
View File

@@ -0,0 +1,25 @@
# GetAllMediaLibraryLibraryOptimizedForStreaming
Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
## Supported Types
### `Operations\GetAllMediaLibraryOptimizedForStreaming1`
```php
/**
* @var Operations\GetAllMediaLibraryOptimizedForStreaming1
*/
Operations\GetAllMediaLibraryOptimizedForStreaming1 $value = /* values here */
```
### `bool`
```php
/**
* @var bool
*/
bool $value = /* values here */
```

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

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

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

@@ -0,0 +1,16 @@
# GetAllMediaLibraryLibraryType
The type of media content
## Values
| Name | Value |
| --------- | --------- |
| `Movie` | movie |
| `TvShow` | show |
| `Season` | season |
| `Episode` | episode |
| `Artist` | artist |
| `Album` | album |

26
docs/Models/Operations/GetAllMediaLibraryMedia.md Normal file
View File

@@ -0,0 +1,26 @@
# GetAllMediaLibraryMedia
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | Unique media identifier. | 387322 |
| `hasVoiceActivity` | *bool* | :heavy_check_mark: | Indicates whether voice activity is detected. | false |
| `part` | array<[Operations\GetAllMediaLibraryPart](../../Models/Operations/GetAllMediaLibraryPart.md)> | :heavy_check_mark: | An array of parts for this media item. | |
| `duration` | *?int* | :heavy_minus_sign: | Duration of the media in milliseconds. | 9610350 |
| `bitrate` | *?int* | :heavy_minus_sign: | Bitrate in bits per second. | 25512 |
| `width` | *?int* | :heavy_minus_sign: | Video width in pixels. | 3840 |
| `height` | *?int* | :heavy_minus_sign: | Video height in pixels. | 1602 |
| `aspectRatio` | *?float* | :heavy_minus_sign: | Aspect ratio of the video. | 2.35 |
| `audioChannels` | *?int* | :heavy_minus_sign: | Number of audio channels. | 6 |
| `displayOffset` | *?int* | :heavy_minus_sign: | N/A | 50 |
| `audioCodec` | *?string* | :heavy_minus_sign: | Audio codec used. | eac3 |
| `videoCodec` | *?string* | :heavy_minus_sign: | Video codec used. | hevc |
| `videoResolution` | *?string* | :heavy_minus_sign: | Video resolution (e.g., 4k). | 4k |
| `container` | *?string* | :heavy_minus_sign: | File container type. | mkv |
| `videoFrameRate` | *?string* | :heavy_minus_sign: | Frame rate of the video. Values found include NTSC, PAL, 24p<br/> | 24p |
| `videoProfile` | *?string* | :heavy_minus_sign: | Video profile (e.g., main 10). | main 10 |
| `audioProfile` | *?string* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
| `optimizedForStreaming` | [Operations\One\|bool\|null](../../Models/Operations/GetAllMediaLibraryOptimizedForStreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
| `has64bitOffsets` | *?bool* | :heavy_minus_sign: | N/A | false |

26
docs/Models/Operations/GetAllMediaLibraryMediaContainer.md Normal file
View File

@@ -0,0 +1,26 @@
# GetAllMediaLibraryMediaContainer
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
| `size` | *int* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
| `totalSize` | *int* | :heavy_check_mark: | Total number of media items in the library. | 50 |
| `offset` | *int* | :heavy_check_mark: | Offset value for pagination. | 0 |
| `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 |
| `content` | *string* | :heavy_check_mark: | The content type or mode. | secondary |
| `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 |
| `thumb` | *string* | :heavy_check_mark: | URL for the thumbnail image of the media container. | /:/resources/show.png |
| `nocache` | *bool* | :heavy_check_mark: | Specifies whether caching is disabled. | true |
| `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 |
| `librarySectionUUID` | *?string* | :heavy_minus_sign: | The universally unique identifier for the library section. | e69655a2-ef48-4aba-bb19-0cc34d1e7d36 |
| `meta` | [?Operations\GetAllMediaLibraryMeta](../../Models/Operations/GetAllMediaLibraryMeta.md) | :heavy_minus_sign: | The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.<br/> | |
| `metadata` | array<[Operations\GetAllMediaLibraryMetadata](../../Models/Operations/GetAllMediaLibraryMetadata.md)> | :heavy_minus_sign: | An array of metadata items. | |

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

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

74
docs/Models/Operations/GetAllMediaLibraryMetadata.md Normal file
View File

@@ -0,0 +1,74 @@
# GetAllMediaLibraryMetadata
Unknown
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `ratingKey` | *string* | :heavy_check_mark: | The rating key (Media ID) of this media item. Note: Although this is always an integer, it is represented as a string in the API. | 58683 |
| `key` | *string* | :heavy_check_mark: | The unique key for the media item. | /library/metadata/58683 |
| `guid` | *string* | :heavy_check_mark: | The globally unique identifier for the media item. | plex://movie/5d7768ba96b655001fdc0408 |
| `slug` | *string* | :heavy_check_mark: | A URL‐friendly version of the media title. | 4-for-texas |
| `type` | [Operations\GetAllMediaLibraryLibraryType](../../Models/Operations/GetAllMediaLibraryLibraryType.md) | :heavy_check_mark: | N/A | movie |
| `title` | *string* | :heavy_check_mark: | The title of the media item. | Avatar: The Way of Water |
| `titleSort` | *string* | :heavy_check_mark: | The sort title used for ordering media items. | Whale |
| `summary` | *string* | :heavy_check_mark: | A synopsis of the media item. | Jake Sully lives with his newfound family formed on the extrasolar moon Pandora.<br/>Once a familiar threat returns to finish what was previously started, Jake must<br/>work with Neytiri and the army of the Na'vi race to protect their home.<br/> |
| `rating` | *float* | :heavy_check_mark: | The critic rating for the media item. | 7.6 |
| `audienceRating` | *float* | :heavy_check_mark: | The audience rating for the media item. | 9.2 |
| `year` | *int* | :heavy_check_mark: | The release year of the media item. | 2022 |
| `tagline` | *string* | :heavy_check_mark: | A brief tagline for the media item. | Return to Pandora. |
| `thumb` | *string* | :heavy_check_mark: | The thumbnail image URL for the media item. | /library/metadata/58683/thumb/1703239236 |
| `art` | *string* | :heavy_check_mark: | The art image URL for the media item. | /library/metadata/58683/art/1703239236 |
| `theme` | *string* | :heavy_check_mark: | The theme URL for the media item. | /library/metadata/1/theme/1705636920 |
| `index` | *int* | :heavy_check_mark: | The index position of the media item. | 1 |
| `childCount` | *int* | :heavy_check_mark: | The number of child items associated with this media item. | 1 |
| `seasonCount` | *int* | :heavy_check_mark: | The total number of seasons (for TV shows). | 2022 |
| `duration` | *int* | :heavy_check_mark: | The duration of the media item in milliseconds. | 11558112 |
| `originallyAvailableAt` | [\DateTime](https://www.php.net/manual/en/class.datetime.php) | :heavy_check_mark: | The original release date of the media item. | 2022-12-14 |
| `addedAt` | *int* | :heavy_check_mark: | N/A | 1556281940 |
| `studio` | *?string* | :heavy_minus_sign: | The studio that produced the media item. | 20th Century Studios |
| `contentRating` | *?string* | :heavy_minus_sign: | The content rating for the media item. | PG-13 |
| `leafCount` | *?int* | :heavy_minus_sign: | The number of leaf items (end nodes) under this media item. | 14 |
| `viewedLeafCount` | *?int* | :heavy_minus_sign: | The number of leaf items that have been viewed. | 0 |
| `updatedAt` | *?int* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
| `audienceRatingImage` | *?string* | :heavy_minus_sign: | The URL for the audience rating image. | rottentomatoes://image.rating.upright |
| `chapterSource` | *?string* | :heavy_minus_sign: | The source from which chapter data is derived. | media |
| `primaryExtraKey` | *?string* | :heavy_minus_sign: | The primary extra key associated with this media item. | /library/metadata/58684 |
| `originalTitle` | *?string* | :heavy_minus_sign: | The original title of the media item (if different). | 映画 ブラッククローバー 魔法帝の剣 |
| `parentRatingKey` | *?string* | :heavy_minus_sign: | The rating key of the parent media item. | 66 |
| `grandparentRatingKey` | *?string* | :heavy_minus_sign: | The rating key of the grandparent media item. | 66 |
| `parentGuid` | *?string* | :heavy_minus_sign: | The GUID of the parent media item. | plex://show/5d9c081b170e24001f2a7be4 |
| `grandparentGuid` | *?string* | :heavy_minus_sign: | The GUID of the grandparent media item. | plex://show/5d9c081b170e24001f2a7be4 |
| `grandparentSlug` | *?string* | :heavy_minus_sign: | The slug for the grandparent media item. | alice-in-borderland-2020 |
| `grandparentKey` | *?string* | :heavy_minus_sign: | The key of the grandparent media item. | /library/metadata/66 |
| `parentKey` | *?string* | :heavy_minus_sign: | The key of the parent media item. | /library/metadata/66 |
| `grandparentTitle` | *?string* | :heavy_minus_sign: | The title of the grandparent media item. | Caprica |
| `grandparentThumb` | *?string* | :heavy_minus_sign: | The thumbnail URL for the grandparent media item. | /library/metadata/66/thumb/1705716261 |
| `grandparentTheme` | *?string* | :heavy_minus_sign: | The theme URL for the grandparent media item. | /library/metadata/66/theme/1705716261 |
| `grandparentArt` | *?string* | :heavy_minus_sign: | The art URL for the grandparent media item. | /library/metadata/66/art/1705716261 |
| `parentTitle` | *?string* | :heavy_minus_sign: | The title of the parent media item. | Caprica |
| `parentIndex` | *?int* | :heavy_minus_sign: | The index position of the parent media item. | 1 |
| `parentThumb` | *?string* | :heavy_minus_sign: | The thumbnail URL for the parent media item. | /library/metadata/66/thumb/1705716261 |
| `ratingImage` | *?string* | :heavy_minus_sign: | The URL for the rating image. | rottentomatoes://image.rating.ripe |
| `viewCount` | *?int* | :heavy_minus_sign: | The number of times this media item has been viewed. | 1 |
| `viewOffset` | *?int* | :heavy_minus_sign: | The current playback offset (in milliseconds). | 5222500 |
| `skipCount` | *?int* | :heavy_minus_sign: | The number of times this media item has been skipped. | 1 |
| `subtype` | *?string* | :heavy_minus_sign: | A classification that further describes the type of media item. For example, 'clip' indicates that the item is a short video clip. | clip |
| `lastRatedAt` | *?int* | :heavy_minus_sign: | The Unix timestamp representing the last time the item was rated. | 1721813113 |
| `createdAtAccuracy` | *?string* | :heavy_minus_sign: | The accuracy of the creation timestamp. This value indicates the format(s) provided (for example, 'epoch,local' means both epoch and local time formats are available). | epoch,local |
| `createdAtTZOffset` | *?string* | :heavy_minus_sign: | The time zone offset for the creation timestamp, represented as a string. This offset indicates the difference from UTC. | 0 |
| `lastViewedAt` | *?int* | :heavy_minus_sign: | Unix timestamp for when the media item was last viewed. | 1682752242 |
| `userRating` | *?float* | :heavy_minus_sign: | The rating provided by a user for the item. This value is expressed as a decimal number. | 10 |
| `image` | array<[Operations\GetAllMediaLibraryImage](../../Models/Operations/GetAllMediaLibraryImage.md)> | :heavy_minus_sign: | N/A | |
| `ultraBlurColors` | [?Operations\GetAllMediaLibraryUltraBlurColors](../../Models/Operations/GetAllMediaLibraryUltraBlurColors.md) | :heavy_minus_sign: | N/A | |
| `media` | array<[Operations\GetAllMediaLibraryMedia](../../Models/Operations/GetAllMediaLibraryMedia.md)> | :heavy_minus_sign: | N/A | |
| `genre` | array<[Operations\GetAllMediaLibraryGenre](../../Models/Operations/GetAllMediaLibraryGenre.md)> | :heavy_minus_sign: | N/A | |
| `country` | array<[Operations\GetAllMediaLibraryCountry](../../Models/Operations/GetAllMediaLibraryCountry.md)> | :heavy_minus_sign: | N/A | |
| `director` | array<[Operations\GetAllMediaLibraryDirector](../../Models/Operations/GetAllMediaLibraryDirector.md)> | :heavy_minus_sign: | N/A | |
| `writer` | array<[Operations\GetAllMediaLibraryWriter](../../Models/Operations/GetAllMediaLibraryWriter.md)> | :heavy_minus_sign: | N/A | |
| `role` | array<[Operations\GetAllMediaLibraryRole](../../Models/Operations/GetAllMediaLibraryRole.md)> | :heavy_minus_sign: | N/A | |
| `guids` | array<[Operations\Guids](../../Models/Operations/Guids.md)> | :heavy_minus_sign: | N/A | |
| `collection` | array<[Operations\GetAllMediaLibraryCollection](../../Models/Operations/GetAllMediaLibraryCollection.md)> | :heavy_minus_sign: | N/A | |

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

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

25
docs/Models/Operations/GetAllMediaLibraryOptimizedForStreaming.md Normal file
View File

@@ -0,0 +1,25 @@
# GetAllMediaLibraryOptimizedForStreaming
Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
## Supported Types
### `Operations\One`
```php
/**
* @var Operations\One
*/
Operations\One $value = /* values here */
```
### `bool`
```php
/**
* @var bool
*/
bool $value = /* values here */
```

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

@@ -0,0 +1,9 @@
# GetAllMediaLibraryOptimizedForStreaming1
## Values
| Name | Value |
| ------ | ------ |
| `Zero` | 0 |
| `One` | 1 |

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

@@ -0,0 +1,23 @@
# GetAllMediaLibraryPart
## 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 |
| `file` | *string* | :heavy_check_mark: | File path for the part. | /mnt/Movies_1/W/Wicked (2024).mkv |
| `size` | *int* | :heavy_check_mark: | File size in bytes. | 30649952104 |
| `accessible` | *?bool* | :heavy_minus_sign: | Indicates if the part is accessible. | true |
| `exists` | *?bool* | :heavy_minus_sign: | Indicates if the part exists. | true |
| `indexes` | *?string* | :heavy_minus_sign: | N/A | sd |
| `duration` | *?int* | :heavy_minus_sign: | Duration of the part in milliseconds. | 9610350 |
| `packetLength` | *?int* | :heavy_minus_sign: | N/A | 188 |
| `container` | *?string* | :heavy_minus_sign: | Container format of the part. | mkv |
| `videoProfile` | *?string* | :heavy_minus_sign: | Video profile for the part. | main 10 |
| `audioProfile` | *?string* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
| `has64bitOffsets` | *?bool* | :heavy_minus_sign: | N/A | false |
| `optimizedForStreaming` | [Operations\GetAllMediaLibraryOptimizedForStreaming1\|bool\|null](../../Models/Operations/GetAllMediaLibraryLibraryOptimizedForStreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
| `hasThumbnail` | [?Operations\GetAllMediaLibraryHasThumbnail](../../Models/Operations/GetAllMediaLibraryHasThumbnail.md) | :heavy_minus_sign: | N/A | 1 |
| `stream` | array<[Operations\GetAllMediaLibraryStream](../../Models/Operations/GetAllMediaLibraryStream.md)> | :heavy_minus_sign: | An array of streams for this part. | |

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

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

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

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

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

@@ -0,0 +1,16 @@
# GetAllMediaLibraryRequest
## 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\GetAllMediaLibraryQueryParamType](../../Models/Operations/GetAllMediaLibraryQueryParamType.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
| `includeMeta` | [?Operations\GetAllMediaLibraryQueryParamIncludeMeta](../../Models/Operations/GetAllMediaLibraryQueryParamIncludeMeta.md) | :heavy_minus_sign: | Adds the Meta object to the response<br/> | 1 |
| `includeGuids` | [?Operations\QueryParamIncludeGuids](../../Models/Operations/QueryParamIncludeGuids.md) | :heavy_minus_sign: | Adds the Guid object to the response<br/> | 1 |
| `includeAdvanced` | [?Operations\IncludeAdvanced](../../Models/Operations/IncludeAdvanced.md) | :heavy_minus_sign: | N/A | 1 |
| `includeCollections` | [?Operations\QueryParamIncludeCollections](../../Models/Operations/QueryParamIncludeCollections.md) | :heavy_minus_sign: | N/A | 1 |
| `includeExternalMedia` | [?Operations\QueryParamIncludeExternalMedia](../../Models/Operations/QueryParamIncludeExternalMedia.md) | :heavy_minus_sign: | N/A | 1 |
| `xPlexContainerStart` | *?int* | :heavy_minus_sign: | The index of the first item to return. If not specified, the first item will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 0<br/> | 0 |
| `xPlexContainerSize` | *?int* | :heavy_minus_sign: | The number of items to return. If not specified, all items will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 50<br/> | 50 |

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

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

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

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

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

@@ -0,0 +1,8 @@
# GetAllMediaLibraryRole
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
| `tag` | *string* | :heavy_check_mark: | The name of the actor for this role | Danny Boyle |

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

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

54
docs/Models/Operations/GetAllMediaLibraryStream.md Normal file
View File

@@ -0,0 +1,54 @@
# GetAllMediaLibraryStream
## 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 |
| `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 |
| `bitrate` | *?int* | :heavy_minus_sign: | Bitrate of the stream. | 24743 |
| `headerCompression` | *?bool* | :heavy_minus_sign: | Indicates whether header compression is enabled. | 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 |

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

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

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

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

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

@@ -0,0 +1,8 @@
# GetAllMediaLibraryWriter
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `tag` | *string* | :heavy_check_mark: | The role of Writer | Danny Boyle |

26
docs/Models/Operations/GetCountriesLibraryMediaContainer.md
View File

@@ -5,18 +5,16 @@
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
| `size` | *float* | :heavy_check_mark: | N/A | 50 |
| `identifier` | *string* | :heavy_check_mark: | N/A | com.plexapp.plugins.library |
| `allowSync` | *bool* | :heavy_check_mark: | N/A | false |
| `art` | *string* | :heavy_check_mark: | N/A | /:/resources/show-fanart.jpg |
| `content` | *string* | :heavy_check_mark: | N/A | secondary |
| `mediaTagPrefix` | *string* | :heavy_check_mark: | N/A | /system/bundle/media/flags/ |
| `mediaTagVersion` | *int* | :heavy_check_mark: | N/A | 1734362201 |
| `nocache` | *bool* | :heavy_check_mark: | N/A | true |
| `thumb` | *string* | :heavy_check_mark: | N/A | /:/resources/show.png |
| `title1` | *string* | :heavy_check_mark: | N/A | TV Series |
| `title2` | *string* | :heavy_check_mark: | N/A | By Country |
| `viewGroup` | *string* | :heavy_check_mark: | N/A | secondary |
| `offset` | *?int* | :heavy_minus_sign: | N/A | |
| `totalSize` | *?int* | :heavy_minus_sign: | N/A | |
| `size` | *int* | :heavy_check_mark: | Number of media items returned in this response. | 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 |
| `content` | *string* | :heavy_check_mark: | The content type or mode. | secondary |
| `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 |
| `directory` | array<[Operations\GetCountriesLibraryDirectory](../../Models/Operations/GetCountriesLibraryDirectory.md)> | :heavy_minus_sign: | N/A | |

26
docs/Models/Operations/GetGenresLibraryMediaContainer.md
View File

@@ -5,18 +5,16 @@
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
| `size` | *float* | :heavy_check_mark: | N/A | 50 |
| `identifier` | *string* | :heavy_check_mark: | N/A | com.plexapp.plugins.library |
| `allowSync` | *bool* | :heavy_check_mark: | N/A | false |
| `art` | *string* | :heavy_check_mark: | N/A | /:/resources/show-fanart.jpg |
| `content` | *string* | :heavy_check_mark: | N/A | secondary |
| `mediaTagPrefix` | *string* | :heavy_check_mark: | N/A | /system/bundle/media/flags/ |
| `mediaTagVersion` | *int* | :heavy_check_mark: | N/A | 1734362201 |
| `nocache` | *bool* | :heavy_check_mark: | N/A | true |
| `thumb` | *string* | :heavy_check_mark: | N/A | /:/resources/show.png |
| `title1` | *string* | :heavy_check_mark: | N/A | TV Shows (Reality) |
| `title2` | *string* | :heavy_check_mark: | N/A | By Genre |
| `viewGroup` | *string* | :heavy_check_mark: | N/A | secondary |
| `offset` | *?int* | :heavy_minus_sign: | N/A | |
| `totalSize` | *?int* | :heavy_minus_sign: | N/A | |
| `size` | *int* | :heavy_check_mark: | Number of media items returned in this response. | 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 |
| `content` | *string* | :heavy_check_mark: | The content type or mode. | secondary |
| `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 |
| `directory` | array<[Operations\GetGenresLibraryDirectory](../../Models/Operations/GetGenresLibraryDirectory.md)> | :heavy_minus_sign: | N/A | |

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

@@ -9,4 +9,5 @@
| `filterType` | *string* | :heavy_check_mark: | N/A | string |
| `key` | *string* | :heavy_check_mark: | N/A | /library/sections/2/genre?type=2 |
| `title` | *string* | :heavy_check_mark: | N/A | Genre |
| `type` | *string* | :heavy_check_mark: | N/A | filter |
| `type` | *string* | :heavy_check_mark: | N/A | filter |
| `advanced` | *?bool* | :heavy_minus_sign: | N/A | true |

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

@@ -11,4 +11,6 @@ The type of media content
| `Movie` | movie |
| `TvShow` | show |
| `Season` | season |
| `Episode` | episode |
| `Episode` | episode |
| `Artist` | artist |
| `Album` | album |

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

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

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

@@ -0,0 +1,8 @@
# GetMediaMetaDataGuids
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `id` | *string* | :heavy_check_mark: | The GUID value. | imdb://tt3032476 |

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

@@ -0,0 +1,11 @@
# GetMediaMetaDataHasThumbnail
Indicates if the part has a thumbnail.
## Values
| Name | Value |
| ------- | ------- |
| `False` | 0 |
| `True` | 1 |

25
docs/Models/Operations/GetMediaMetaDataLibraryOptimizedForStreaming.md Normal file
View File

@@ -0,0 +1,25 @@
# GetMediaMetaDataLibraryOptimizedForStreaming
Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
## Supported Types
### `Operations\GetMediaMetaDataOptimizedForStreaming1`
```php
/**
* @var Operations\GetMediaMetaDataOptimizedForStreaming1
*/
Operations\GetMediaMetaDataOptimizedForStreaming1 $value = /* values here */
```
### `bool`
```php
/**
* @var bool
*/
bool $value = /* values here */
```

38
docs/Models/Operations/GetMediaMetaDataMedia.md
View File

@@ -3,20 +3,24 @@
## 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. | |
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | Unique media identifier. | 387322 |
| `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. | |
| `duration` | *?int* | :heavy_minus_sign: | Duration of the media in milliseconds. | 9610350 |
| `bitrate` | *?int* | :heavy_minus_sign: | Bitrate in bits per second. | 25512 |
| `width` | *?int* | :heavy_minus_sign: | Video width in pixels. | 3840 |
| `height` | *?int* | :heavy_minus_sign: | Video height in pixels. | 1602 |
| `aspectRatio` | *?float* | :heavy_minus_sign: | Aspect ratio of the video. | 2.35 |
| `audioChannels` | *?int* | :heavy_minus_sign: | Number of audio channels. | 6 |
| `displayOffset` | *?int* | :heavy_minus_sign: | N/A | 50 |
| `audioCodec` | *?string* | :heavy_minus_sign: | Audio codec used. | eac3 |
| `videoCodec` | *?string* | :heavy_minus_sign: | Video codec used. | hevc |
| `videoResolution` | *?string* | :heavy_minus_sign: | Video resolution (e.g., 4k). | 4k |
| `container` | *?string* | :heavy_minus_sign: | File container type. | mkv |
| `videoFrameRate` | *?string* | :heavy_minus_sign: | Frame rate of the video. Values found include NTSC, PAL, 24p<br/> | 24p |
| `videoProfile` | *?string* | :heavy_minus_sign: | Video profile (e.g., main 10). | main 10 |
| `audioProfile` | *?string* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
| `optimizedForStreaming` | [Operations\OptimizedForStreaming1\|bool\|null](../../Models/Operations/GetMediaMetaDataOptimizedForStreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
| `has64bitOffsets` | *?bool* | :heavy_minus_sign: | N/A | false |

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

@@ -5,7 +5,7 @@
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
| `size` | *float* | :heavy_check_mark: | N/A | 50 |
| `size` | *int* | :heavy_check_mark: | Number of media items returned in this response. | 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 |

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

@@ -13,21 +13,15 @@
| `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 |
| `addedAt` | *int* | :heavy_check_mark: | N/A | 1556281940 |
| `updatedAt` | *int* | :heavy_check_mark: | N/A | 1556281940 |
| `image` | array<[Operations\GetMediaMetaDataImage](../../Models/Operations/GetMediaMetaDataImage.md)> | :heavy_check_mark: | An array of image objects. | |
| `ultraBlurColors` | [Operations\GetMediaMetaDataUltraBlurColors](../../Models/Operations/GetMediaMetaDataUltraBlurColors.md) | :heavy_check_mark: | N/A | |
| `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 |
@@ -38,19 +32,25 @@
| `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 |
| `contentRating` | *?string* | :heavy_minus_sign: | The content rating (e.g., TV-MA). | TV-MA |
| `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 |
| `audienceRating` | *?float* | :heavy_minus_sign: | The audience rating for the content. | 8.7 |
| `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 |
| `rating` | *?float* | :heavy_minus_sign: | The general rating | 6 |
| `ratingImage` | *?string* | :heavy_minus_sign: | The URL or identifier for the rating image (e.g., Rotten Tomatoes rating image). | rottentomatoes://image.rating.ripe |
| `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 |
| `originallyAvailableAt` | [\DateTime](https://www.php.net/manual/en/class.datetime.php) | :heavy_minus_sign: | The original release date. | 2015-02-08 |
| `leafCount` | *?int* | :heavy_minus_sign: | The total number of episodes (or leaves). | 63 |
| `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 |
| `audienceRatingImage` | *?string* | :heavy_minus_sign: | The URL for the audience rating image. | themoviedb://image.rating |
| `parentIndex` | *?int* | :heavy_minus_sign: | The index number of the parent entity, which could indicate its order or position. | 2 |
| `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 |
@@ -58,6 +58,8 @@
| `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. | |
| `guids` | array<[Operations\GetMediaMetaDataGuids](../../Models/Operations/GetMediaMetaDataGuids.md)> | :heavy_minus_sign: | An array of GUID objects. | |
| `ratings` | array<[Operations\Ratings](../../Models/Operations/Ratings.md)> | :heavy_minus_sign: | An array of rating objects. | |
| `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. | |

25
docs/Models/Operations/GetMediaMetaDataOptimizedForStreaming.md Normal file
View File

@@ -0,0 +1,25 @@
# GetMediaMetaDataOptimizedForStreaming
Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
## Supported Types
### `Operations\OptimizedForStreaming1`
```php
/**
* @var Operations\OptimizedForStreaming1
*/
Operations\OptimizedForStreaming1 $value = /* values here */
```
### `bool`
```php
/**
* @var bool
*/
bool $value = /* values here */
```

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

@@ -0,0 +1,9 @@
# GetMediaMetaDataOptimizedForStreaming1
## Values
| Name | Value |
| ------ | ------ |
| `Zero` | 0 |
| `One` | 1 |

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

@@ -3,16 +3,21 @@
## 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 |
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | Unique part identifier. | 418385 |
| `key` | *string* | :heavy_check_mark: | Key to access this part. | /library/parts/418385/1735864239/file.mkv |
| `file` | *string* | :heavy_check_mark: | File path for the part. | /mnt/Movies_1/W/Wicked (2024).mkv |
| `size` | *int* | :heavy_check_mark: | File size in bytes. | 30649952104 |
| `accessible` | *?bool* | :heavy_minus_sign: | Indicates if the part is accessible. | true |
| `exists` | *?bool* | :heavy_minus_sign: | Indicates if the part exists. | true |
| `indexes` | *?string* | :heavy_minus_sign: | N/A | sd |
| `duration` | *?int* | :heavy_minus_sign: | Duration of the part in milliseconds. | 9610350 |
| `packetLength` | *?int* | :heavy_minus_sign: | N/A | 188 |
| `container` | *?string* | :heavy_minus_sign: | Container format of the part. | mkv |
| `videoProfile` | *?string* | :heavy_minus_sign: | Video profile for the part. | main 10 |
| `audioProfile` | *?string* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
| `has64bitOffsets` | *?bool* | :heavy_minus_sign: | N/A | false |
| `optimizedForStreaming` | [Operations\GetMediaMetaDataOptimizedForStreaming1\|bool\|null](../../Models/Operations/GetMediaMetaDataLibraryOptimizedForStreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
| `hasThumbnail` | [?Operations\GetMediaMetaDataHasThumbnail](../../Models/Operations/GetMediaMetaDataHasThumbnail.md) | :heavy_minus_sign: | N/A | 1 |
| `stream` | array<[Operations\GetMediaMetaDataStream](../../Models/Operations/GetMediaMetaDataStream.md)> | :heavy_minus_sign: | An array of streams for this part. | |

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

@@ -9,13 +9,14 @@
| `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 |
| `bitrate` | *?int* | :heavy_minus_sign: | Bitrate of the stream. | 24743 |
| `headerCompression` | *?bool* | :heavy_minus_sign: | Indicates whether header compression is enabled. | 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 |

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

@@ -9,4 +9,5 @@
| `filterType` | *string* | :heavy_check_mark: | N/A | string |
| `key` | *string* | :heavy_check_mark: | N/A | /library/sections/2/genre?type=2 |
| `title` | *string* | :heavy_check_mark: | N/A | Genre |
| `type` | *string* | :heavy_check_mark: | N/A | filter |
| `type` | *string* | :heavy_check_mark: | N/A | filter |
| `advanced` | *?bool* | :heavy_minus_sign: | N/A | true |

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

@@ -11,4 +11,6 @@ The type of media content
| `Movie` | movie |
| `TvShow` | show |
| `Season` | season |
| `Episode` | episode |
| `Episode` | episode |
| `Artist` | artist |
| `Album` | album |

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

@@ -9,4 +9,5 @@
| `filterType` | *string* | :heavy_check_mark: | N/A | string |
| `key` | *string* | :heavy_check_mark: | N/A | /library/sections/2/genre?type=2 |
| `title` | *string* | :heavy_check_mark: | N/A | Genre |
| `type` | *string* | :heavy_check_mark: | N/A | filter |
| `type` | *string* | :heavy_check_mark: | N/A | filter |
| `advanced` | *?bool* | :heavy_minus_sign: | N/A | true |

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

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

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

@@ -5,7 +5,7 @@
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
| `size` | *float* | :heavy_check_mark: | N/A | 50 |
| `size` | *int* | :heavy_check_mark: | N/A | 50 |
| `offset` | *?int* | :heavy_minus_sign: | N/A | |
| `totalSize` | *?int* | :heavy_minus_sign: | N/A | |
| `identifier` | *?string* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |

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

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

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

@@ -0,0 +1,11 @@
# GetSearchAllLibrariesQueryParamIncludeCollections
Whether to include collections in the search results.
## Values
| Name | Value |
| --------- | --------- |
| `Disable` | 0 |
| `Enable` | 1 |

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

@@ -0,0 +1,11 @@
# GetSearchAllLibrariesQueryParamIncludeExternalMedia
Whether to include external media in the search results.
## Values
| Name | Value |
| --------- | --------- |
| `Disable` | 0 |
| `Enable` | 1 |

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

@@ -3,11 +3,11 @@
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
| `query` | *string* | :heavy_check_mark: | The search query term. | |
| `clientID` | *string* | :heavy_check_mark: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
| `limit` | *?int* | :heavy_minus_sign: | Limit the number of results returned. | |
| `searchTypes` | array<[Operations\SearchTypes](../../Models/Operations/SearchTypes.md)> | :heavy_minus_sign: | A comma-separated list of search types to include. Valid values are: movies, music, otherVideos, people, tv.<br/> | movies,music,otherVideos,people,tv |
| `includeCollections` | [?Operations\QueryParamIncludeCollections](../../Models/Operations/QueryParamIncludeCollections.md) | :heavy_minus_sign: | Whether to include collections in the search results. | 1 |
| `includeExternalMedia` | [?Operations\QueryParamIncludeExternalMedia](../../Models/Operations/QueryParamIncludeExternalMedia.md) | :heavy_minus_sign: | Whether to include external media in the search results. | 1 |
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| `query` | *string* | :heavy_check_mark: | The search query term. | |
| `clientID` | *string* | :heavy_check_mark: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
| `limit` | *?int* | :heavy_minus_sign: | Limit the number of results returned. | |
| `searchTypes` | array<[Operations\SearchTypes](../../Models/Operations/SearchTypes.md)> | :heavy_minus_sign: | A comma-separated list of search types to include. Valid values are: movies, music, otherVideos, people, tv.<br/> | movies,music,otherVideos,people,tv |
| `includeCollections` | [?Operations\GetSearchAllLibrariesQueryParamIncludeCollections](../../Models/Operations/GetSearchAllLibrariesQueryParamIncludeCollections.md) | :heavy_minus_sign: | Whether to include collections in the search results. | 1 |
| `includeExternalMedia` | [?Operations\GetSearchAllLibrariesQueryParamIncludeExternalMedia](../../Models/Operations/GetSearchAllLibrariesQueryParamIncludeExternalMedia.md) | :heavy_minus_sign: | Whether to include external media in the search results. | 1 |

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

@@ -11,4 +11,6 @@ The type of media content
| `Movie` | movie |
| `TvShow` | show |
| `Season` | season |
| `Episode` | episode |
| `Episode` | episode |
| `Artist` | artist |
| `Album` | album |

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

@@ -3,6 +3,6 @@
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `id` | *string* | :heavy_check_mark: | The GUID value. | imdb://tt3032476 |
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
| `id` | *?string* | :heavy_minus_sign: | The unique identifier for the Guid. Can be imdb://tt0286347, tmdb://1763, tvdb://2337<br/> | tvdb://2337 |

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

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

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

@@ -0,0 +1,9 @@
# One
## Values
| Name | Value |
| ------ | ------ |
| `Zero` | 0 |
| `One` | 1 |

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

@@ -0,0 +1,9 @@
# OptimizedForStreaming1
## Values
| Name | Value |
| ------ | ------ |
| `Zero` | 0 |
| `One` | 1 |

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

@@ -1,7 +1,5 @@
# QueryParamIncludeCollections
Whether to include collections in the search results.
## Values

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

@@ -1,7 +1,5 @@
# QueryParamIncludeExternalMedia
Whether to include external media in the search results.
## Values

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

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

2
docs/Models/Operations/Rating.md → docs/Models/Operations/Ratings.md
View File

@@ -1,4 +1,4 @@
# Rating
# Ratings
## Fields

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

@@ -7,7 +7,6 @@ A key representing a specific tag within the section.
| Name | Value |
| ---------------- | ---------------- |
| `All` | all |
| `Unwatched` | unwatched |
| `Newest` | newest |
| `RecentlyAdded` | recentlyAdded |
@@ -15,12 +14,9 @@ A key representing a specific tag within the section.
| `OnDeck` | onDeck |
| `Collection` | collection |
| `Edition` | edition |
| `Genre` | genre |
| `Year` | year |
| `Decade` | decade |
| `Director` | director |
| `Actor` | actor |
| `Country` | country |
| `ContentRating` | contentRating |
| `Rating` | rating |
| `Resolution` | resolution |

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

@@ -11,6 +11,7 @@ API Calls interacting with Plex Media Server Libraries
* [deleteLibrary](#deletelibrary) - Delete Library Section
* [getActorsLibrary](#getactorslibrary) - Get Actors of library media
* [getAllLibraries](#getalllibraries) - Get All Libraries
* [getAllMediaLibrary](#getallmedialibrary) - Get all media of library
* [getCountriesLibrary](#getcountrieslibrary) - Get Countries of library media
* [getGenresLibrary](#getgenreslibrary) - Get Genres of library media
* [getLibraryDetails](#getlibrarydetails) - Get Library Details
@@ -174,6 +175,59 @@ if ($response->object !== null) {
| Errors\GetAllLibrariesUnauthorized | 401 | application/json |
| Errors\SDKException | 4XX, 5XX | \*/\* |
## getAllMediaLibrary
Retrieves a list of all general media data for 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();
$request = new Operations\GetAllMediaLibraryRequest(
sectionKey: 9518,
type: Operations\GetAllMediaLibraryQueryParamType::TvShow,
);
$response = $sdk->library->getAllMediaLibrary(
request: $request
);
if ($response->object !== null) {
// handle response
}
```
### Parameters
| Parameter | Type | Required | Description |
| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
| `$request` | [Operations\GetAllMediaLibraryRequest](../../Models/Operations/GetAllMediaLibraryRequest.md) | :heavy_check_mark: | The request object to use for the request. |
### Response
**[?Operations\GetAllMediaLibraryResponse](../../Models/Operations/GetAllMediaLibraryResponse.md)**
### Errors
| Error Type | Status Code | Content Type |
| ------------------------------------- | ------------------------------------- | ------------------------------------- |
| Errors\GetAllMediaLibraryBadRequest | 400 | application/json |
| Errors\GetAllMediaLibraryUnauthorized | 401 | application/json |
| Errors\SDKException | 4XX, 5XX | \*/\* |
## getCountriesLibrary
Retrieves a list of all the countries that are found for the media in this library.

89
src/Library.php
View File

@@ -307,6 +307,95 @@ class Library
}
}
/**
* Get all media of library
*
* Retrieves a list of all general media data for this library.
*
*
* @param Operations\GetAllMediaLibraryRequest $request
* @return Operations\GetAllMediaLibraryResponse
* @throws \LukeHagar\Plex_API\Models\Errors\SDKException
*/
public function getAllMediaLibrary(Operations\GetAllMediaLibraryRequest $request, ?Options $options = null): Operations\GetAllMediaLibraryResponse
{
$baseUrl = Utils\Utils::templateUrl($this->sdkConfiguration->getServerUrl(), $this->sdkConfiguration->getServerDefaults());
$url = Utils\Utils::generateUrl($baseUrl, '/library/sections/{sectionKey}/all', Operations\GetAllMediaLibraryRequest::class, $request);
$urlOverride = null;
$httpOptions = ['http_errors' => false];
$qp = Utils\Utils::getQueryParams(Operations\GetAllMediaLibraryRequest::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-all-media-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\GetAllMediaLibraryResponseBody', 'json', DeserializationContext::create()->setRequireAllRequiredProperties(true));
$response = new Operations\GetAllMediaLibraryResponse(
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\GetAllMediaLibraryBadRequest', '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\GetAllMediaLibraryUnauthorized', '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 Countries of library media
*

53
src/Models/Errors/GetAllMediaLibraryBadRequest.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;
/** GetAllMediaLibraryBadRequest - Bad Request - A parameter was not specified, or was specified incorrectly. */
class GetAllMediaLibraryBadRequest
{
/**
* $errors
*
* @var ?array<GetAllMediaLibraryErrors> $errors
*/
#[\Speakeasy\Serializer\Annotation\SerializedName('errors')]
#[\Speakeasy\Serializer\Annotation\Type('array<\LukeHagar\Plex_API\Models\Errors\GetAllMediaLibraryErrors>|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<GetAllMediaLibraryErrors> $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(): GetAllMediaLibraryBadRequestThrowable
{
$serializer = Utils\JSON::createSerializer();
$message = $serializer->serialize($this, 'json');
$code = -1;
return new GetAllMediaLibraryBadRequestThrowable($message, (int) $code, $this);
}
}

20
src/Models/Errors/GetAllMediaLibraryBadRequestThrowable.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 GetAllMediaLibraryBadRequestThrowable extends \RuntimeException
{
public GetAllMediaLibraryBadRequest $container;
public function __construct(string $message, int $statusCode, GetAllMediaLibraryBadRequest $container)
{
parent::__construct($message, $statusCode);
$this->container = $container;
}
}

50
src/Models/Errors/GetAllMediaLibraryErrors.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 GetAllMediaLibraryErrors
{
/**
*
* @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/GetAllMediaLibraryLibraryErrors.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 GetAllMediaLibraryLibraryErrors
{
/**
*
* @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/GetAllMediaLibraryUnauthorized.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;
/** GetAllMediaLibraryUnauthorized - Unauthorized - Returned if the X-Plex-Token is missing from the header or query. */
class GetAllMediaLibraryUnauthorized
{
/**
* $errors
*
* @var ?array<GetAllMediaLibraryLibraryErrors> $errors
*/
#[\Speakeasy\Serializer\Annotation\SerializedName('errors')]
#[\Speakeasy\Serializer\Annotation\Type('array<\LukeHagar\Plex_API\Models\Errors\GetAllMediaLibraryLibraryErrors>|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<GetAllMediaLibraryLibraryErrors> $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(): GetAllMediaLibraryUnauthorizedThrowable
{
$serializer = Utils\JSON::createSerializer();
$message = $serializer->serialize($this, 'json');
$code = -1;
return new GetAllMediaLibraryUnauthorizedThrowable($message, (int) $code, $this);
}
}

20
src/Models/Errors/GetAllMediaLibraryUnauthorizedThrowable.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 GetAllMediaLibraryUnauthorizedThrowable extends \RuntimeException
{
public GetAllMediaLibraryUnauthorized $container;
public function __construct(string $message, int $statusCode, GetAllMediaLibraryUnauthorized $container)
{
parent::__construct($message, $statusCode);
$this->container = $container;
}
}

9
src/Models/Operations/GetActorsLibraryMediaContainer.php
View File

@@ -12,11 +12,12 @@ namespace LukeHagar\Plex_API\Models\Operations;
class GetActorsLibraryMediaContainer
{
/**
* Number of media items returned in this response.
*
* @var float $size
* @var int $size
*/
#[\Speakeasy\Serializer\Annotation\SerializedName('size')]
public float $size;
public int $size;
/**
* Indicates whether syncing is allowed.
@@ -117,7 +118,7 @@ class GetActorsLibraryMediaContainer
public ?array $directory = null;
/**
* @param float $size
* @param int $size
* @param bool $allowSync
* @param string $art
* @param string $identifier
@@ -132,7 +133,7 @@ class GetActorsLibraryMediaContainer
* @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)
public function __construct(int $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;

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

@@ -0,0 +1,21 @@
<?php
/**
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
*/
declare(strict_types=1);
namespace LukeHagar\Plex_API\Models\Operations;
/**
* The direction of the sort. Can be either `asc` or `desc`.
*
*
*/
enum GetAllMediaLibraryActiveDirection: string
{
case Ascending = 'asc';
case Descending = 'desc';
}

30
src/Models/Operations/GetAllMediaLibraryCollection.php Normal file
View File

@@ -0,0 +1,30 @@
<?php
/**
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
*/
declare(strict_types=1);
namespace LukeHagar\Plex_API\Models\Operations;
class GetAllMediaLibraryCollection
{
/**
* The user-made collection this media item belongs to
*
* @var string $tag
*/
#[\Speakeasy\Serializer\Annotation\SerializedName('tag')]
public string $tag;
/**
* @param string $tag
* @phpstan-pure
*/
public function __construct(string $tag)
{
$this->tag = $tag;
}
}

30
src/Models/Operations/GetAllMediaLibraryCountry.php Normal file
View File

@@ -0,0 +1,30 @@
<?php
/**
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
*/
declare(strict_types=1);
namespace LukeHagar\Plex_API\Models\Operations;
class GetAllMediaLibraryCountry
{
/**
* The country of origin of this media item
*
* @var string $tag
*/
#[\Speakeasy\Serializer\Annotation\SerializedName('tag')]
public string $tag;
/**
* @param string $tag
* @phpstan-pure
*/
public function __construct(string $tag)
{
$this->tag = $tag;
}
}

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

@@ -0,0 +1,21 @@
<?php
/**
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
*/
declare(strict_types=1);
namespace LukeHagar\Plex_API\Models\Operations;
/**
* The direction of the sort. Can be either `asc` or `desc`.
*
*
*/
enum GetAllMediaLibraryDefaultDirection: string
{
case Ascending = 'asc';
case Descending = 'desc';
}

30
src/Models/Operations/GetAllMediaLibraryDirector.php Normal file
View File

@@ -0,0 +1,30 @@
<?php
/**
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
*/
declare(strict_types=1);
namespace LukeHagar\Plex_API\Models\Operations;
class GetAllMediaLibraryDirector
{
/**
* The role of Director
*
* @var string $tag
*/
#[\Speakeasy\Serializer\Annotation\SerializedName('tag')]
public string $tag;
/**
* @param string $tag
* @phpstan-pure
*/
public function __construct(string $tag)
{
$this->tag = $tag;
}
}

57
src/Models/Operations/GetAllMediaLibraryField.php Normal file
View File

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

40
src/Models/Operations/GetAllMediaLibraryFieldType.php Normal file
View File

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

75
src/Models/Operations/GetAllMediaLibraryFilter.php Normal file
View File

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

30
src/Models/Operations/GetAllMediaLibraryGenre.php Normal file
View File

@@ -0,0 +1,30 @@
<?php
/**
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
*/
declare(strict_types=1);
namespace LukeHagar\Plex_API\Models\Operations;
class GetAllMediaLibraryGenre
{
/**
* The country of origin of this media item
*
* @var string $tag
*/
#[\Speakeasy\Serializer\Annotation\SerializedName('tag')]
public string $tag;
/**
* @param string $tag
* @phpstan-pure
*/
public function __construct(string $tag)
{
$this->tag = $tag;
}
}

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

@@ -0,0 +1,17 @@
<?php
/**
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
*/
declare(strict_types=1);
namespace LukeHagar\Plex_API\Models\Operations;
/** Indicates if the part has a thumbnail. */
enum GetAllMediaLibraryHasThumbnail: string
{
case False = '0';
case True = '1';
}

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

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

18
src/Models/Operations/GetAllMediaLibraryLibraryResponseType.php Normal file
View File

@@ -0,0 +1,18 @@
<?php
/**
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
*/
declare(strict_types=1);
namespace LukeHagar\Plex_API\Models\Operations;
enum GetAllMediaLibraryLibraryResponseType: string
{
case CoverPoster = 'coverPoster';
case Background = 'background';
case Snapshot = 'snapshot';
case ClearLogo = 'clearLogo';
}

25
src/Models/Operations/GetAllMediaLibraryLibraryType.php Normal file
View File

@@ -0,0 +1,25 @@
<?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 content
*
*
*/
enum GetAllMediaLibraryLibraryType: string
{
case Movie = 'movie';
case TvShow = 'show';
case Season = 'season';
case Episode = 'episode';
case Artist = 'artist';
case Album = 'album';
}

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