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

Browse Source
This commit is contained in:
speakeasybot
2024-06-22 00:13:46 +00:00
parent 25d278a1e8
commit bee51231a2
91 changed files with 2680 additions and 609 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -1,12 +1,11 @@
# Filter
Filter
Filters content by field and direction/equality
(Unknown if viewedAt is the only supported column)
## Values
| Name | Value |
| ----------- | ----------- |
| `All` | all |
| `Available` | available |
| `Released` | released |
## Fields
| Field | Type | Required | Description |
| ----------- | ----------- | ----------- | ----------- |

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

@@ -0,0 +1,15 @@
# GetBandwidthStatisticsAccount
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
| `id` | *?int* | :heavy_minus_sign: | N/A | 238960586 |
| `key` | *?string* | :heavy_minus_sign: | N/A | /accounts/238960586 |
| `name` | *?string* | :heavy_minus_sign: | N/A | Diane |
| `defaultAudioLanguage` | *?string* | :heavy_minus_sign: | N/A | en |
| `autoSelectAudio` | *?bool* | :heavy_minus_sign: | N/A | true |
| `defaultSubtitleLanguage` | *?string* | :heavy_minus_sign: | N/A | en |
| `subtitleMode` | *?int* | :heavy_minus_sign: | N/A | 1 |
| `thumb` | *?string* | :heavy_minus_sign: | N/A | https://plex.tv/users/50d83634246da1de/avatar?c=1707110967 |

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

@@ -0,0 +1,12 @@
# GetBandwidthStatisticsDevice
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- |
| `id` | *?int* | :heavy_minus_sign: | N/A | 208 |
| `name` | *?string* | :heavy_minus_sign: | N/A | Roku Express |
| `platform` | *?string* | :heavy_minus_sign: | N/A | Roku |
| `clientIdentifier` | *?string* | :heavy_minus_sign: | N/A | 793095d235660625108ef785cc7646e9 |
| `createdAt` | *?int* | :heavy_minus_sign: | N/A | 1706470556 |

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

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

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

@@ -0,0 +1,11 @@
# GetBandwidthStatisticsMediaContainer
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| `size` | *?int* | :heavy_minus_sign: | N/A | 5497 |
| `device` | array<[\LukeHagar\Plex_API\Models\Operations\GetBandwidthStatisticsDevice](../../Models/Operations/GetBandwidthStatisticsDevice.md)> | :heavy_minus_sign: | N/A | |
| `account` | array<[\LukeHagar\Plex_API\Models\Operations\GetBandwidthStatisticsAccount](../../Models/Operations/GetBandwidthStatisticsAccount.md)> | :heavy_minus_sign: | N/A | |
| `statisticsBandwidth` | array<[\LukeHagar\Plex_API\Models\Operations\StatisticsBandwidth](../../Models/Operations/StatisticsBandwidth.md)> | :heavy_minus_sign: | N/A | |

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

@@ -0,0 +1,8 @@
# GetBandwidthStatisticsRequest
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| `timespan` | *?int* | :heavy_minus_sign: | The timespan to retrieve statistics for<br/>the exact meaning of this parameter is not known<br/> | 4 |

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

@@ -0,0 +1,12 @@
# GetBandwidthStatisticsResponse
## 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 |
| `twoHundredApplicationJsonObject` | [?\LukeHagar\Plex_API\Models\Operations\GetBandwidthStatisticsResponseBody](../../Models/Operations/GetBandwidthStatisticsResponseBody.md) | :heavy_minus_sign: | Bandwidth Statistics |
| `fourHundredAndOneApplicationJsonObject` | [?\LukeHagar\Plex_API\Models\Operations\GetBandwidthStatisticsStatisticsResponseBody](../../Models/Operations/GetBandwidthStatisticsStatisticsResponseBody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |

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

@@ -0,0 +1,10 @@
# GetBandwidthStatisticsResponseBody
Bandwidth Statistics
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| `mediaContainer` | [?\LukeHagar\Plex_API\Models\Operations\GetBandwidthStatisticsMediaContainer](../../Models/Operations/GetBandwidthStatisticsMediaContainer.md) | :heavy_minus_sign: | N/A |

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

@@ -0,0 +1,10 @@
# GetBandwidthStatisticsStatisticsResponseBody
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ |
| `errors` | array<[\LukeHagar\Plex_API\Models\Operations\GetBandwidthStatisticsErrors](../../Models/Operations/GetBandwidthStatisticsErrors.md)> | :heavy_minus_sign: | N/A |

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

@@ -9,7 +9,7 @@
| `allowSync` | *?bool* | :heavy_minus_sign: | N/A | true |
| `art` | *?string* | :heavy_minus_sign: | N/A | /:/resources/movie-fanart.jpg |
| `identifier` | *?string* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
| `librarySectionID` | *?int* | :heavy_minus_sign: | N/A | 1 |
| `librarySectionID` | *mixed* | :heavy_minus_sign: | N/A | |
| `librarySectionTitle` | *?string* | :heavy_minus_sign: | N/A | Movies |
| `librarySectionUUID` | *?string* | :heavy_minus_sign: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
| `mediaTagPrefix` | *?string* | :heavy_minus_sign: | N/A | /system/bundle/media/flags/ |

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

@@ -3,7 +3,8 @@
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
| `sectionId` | *mixed* | :heavy_check_mark: | the Id of the library to query |
| `tag` | [\LukeHagar\Plex_API\Models\Operations\Tag](../../Models/Operations/Tag.md) | :heavy_check_mark: | A key representing a specific tag within the section. |
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
| `sectionId` | *mixed* | :heavy_check_mark: | the Id of the library to query | |
| `tag` | [\LukeHagar\Plex_API\Models\Operations\Tag](../../Models/Operations/Tag.md) | :heavy_check_mark: | A key representing a specific tag within the section. | |
| `includeGuids` | *?int* | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |

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

@@ -3,6 +3,7 @@
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
| `ratingKey` | *float* | :heavy_check_mark: | the id of the library item to return the children of. |
| Field | Type | Required | Description |
| ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- |
| `ratingKey` | *float* | :heavy_check_mark: | the id of the library item to return the children of. |
| `includeElements` | *?string* | :heavy_minus_sign: | Adds additional elements to the response. Supported types are (Stream)<br/> |

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

@@ -18,4 +18,4 @@ The Pin
| `createdAt` | [\DateTime](https://www.php.net/manual/en/class.datetime.php) | :heavy_minus_sign: | N/A | 2023-04-12 17:00:03 +0000 UTC |
| `expiresAt` | [\DateTime](https://www.php.net/manual/en/class.datetime.php) | :heavy_minus_sign: | N/A | 2023-04-12 17:30:03 +0000 UTC |
| `authToken` | *?string* | :heavy_minus_sign: | N/A | |
| `newRegistration` | *?string* | :heavy_minus_sign: | N/A | |
| `newRegistration` | *?bool* | :heavy_minus_sign: | N/A | |

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

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

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

@@ -0,0 +1,9 @@
# GetResourcesStatisticsMediaContainer
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
| `size` | *?int* | :heavy_minus_sign: | N/A | 5497 |
| `statisticsResources` | array<[\LukeHagar\Plex_API\Models\Operations\StatisticsResources](../../Models/Operations/StatisticsResources.md)> | :heavy_minus_sign: | N/A | |

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

@@ -0,0 +1,8 @@
# GetResourcesStatisticsRequest
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| `timespan` | *?int* | :heavy_minus_sign: | The timespan to retrieve statistics for<br/>the exact meaning of this parameter is not known<br/> | 4 |

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

@@ -0,0 +1,12 @@
# GetResourcesStatisticsResponse
## 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 |
| `twoHundredApplicationJsonObject` | [?\LukeHagar\Plex_API\Models\Operations\GetResourcesStatisticsResponseBody](../../Models/Operations/GetResourcesStatisticsResponseBody.md) | :heavy_minus_sign: | Resource Statistics |
| `fourHundredAndOneApplicationJsonObject` | [?\LukeHagar\Plex_API\Models\Operations\GetResourcesStatisticsStatisticsResponseBody](../../Models/Operations/GetResourcesStatisticsStatisticsResponseBody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |

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

@@ -0,0 +1,10 @@
# GetResourcesStatisticsResponseBody
Resource Statistics
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| `mediaContainer` | [?\LukeHagar\Plex_API\Models\Operations\GetResourcesStatisticsMediaContainer](../../Models/Operations/GetResourcesStatisticsMediaContainer.md) | :heavy_minus_sign: | N/A |

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

@@ -0,0 +1,10 @@
# GetResourcesStatisticsStatisticsResponseBody
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ |
| `errors` | array<[\LukeHagar\Plex_API\Models\Operations\GetResourcesStatisticsErrors](../../Models/Operations/GetResourcesStatisticsErrors.md)> | :heavy_minus_sign: | N/A |

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

@@ -0,0 +1,11 @@
# GetSessionHistoryRequest
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `sort` | *?string* | :heavy_minus_sign: | Sorts the results by the specified field followed by the direction (asc, desc)<br/> | |
| `accountId` | *?int* | :heavy_minus_sign: | Filter results by those that are related to a specific users id<br/> | 1 |
| `filter` | [?\LukeHagar\Plex_API\Models\Operations\Filter](../../Models/Operations/Filter.md) | :heavy_minus_sign: | Filters content by field and direction/equality<br/>(Unknown if viewedAt is the only supported column)<br/> | {<br/>"viewed-at-greater-than": {<br/>"value": "viewedAt\u003e"<br/>},<br/>"viewed-at-greater-than-or-equal-to": {<br/>"value": "viewedAt\u003e=\u003e"<br/>},<br/>"viewed-at-less-than": {<br/>"value": "viewedAt\u003c"<br/>}<br/>} |
| `librarySectionID` | *?int* | :heavy_minus_sign: | Filters the results based on the id of a valid library section<br/> | 12 |

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

@@ -39,6 +39,6 @@
| `updatedAt` | *?int* | :heavy_minus_sign: | N/A | 1705543314 |
| `viewOffset` | *?int* | :heavy_minus_sign: | N/A | 1000 |
| `media` | array<[\LukeHagar\Plex_API\Models\Operations\GetSessionsMedia](../../Models/Operations/GetSessionsMedia.md)> | :heavy_minus_sign: | N/A | |
| `user` | [?\LukeHagar\Plex_API\Models\Operations\User](../../Models/Operations/User.md) | :heavy_minus_sign: | N/A | |
| `user` | [?\LukeHagar\Plex_API\Models\Operations\GetSessionsUser](../../Models/Operations/GetSessionsUser.md) | :heavy_minus_sign: | N/A | |
| `player` | [?\LukeHagar\Plex_API\Models\Operations\Player](../../Models/Operations/Player.md) | :heavy_minus_sign: | N/A | |
| `session` | [?\LukeHagar\Plex_API\Models\Operations\Session](../../Models/Operations/Session.md) | :heavy_minus_sign: | N/A | |

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

@@ -0,0 +1,10 @@
# GetSessionsUser
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
| `id` | *?string* | :heavy_minus_sign: | N/A | 1 |
| `thumb` | *?string* | :heavy_minus_sign: | N/A | https://plex.tv/users/844780fc6f8a26b5/avatar?c=1705853661 |
| `title` | *?string* | :heavy_minus_sign: | N/A | Blindkitty38 |

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

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

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

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

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

@@ -0,0 +1,8 @@
# GetTopWatchedContentGuids
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `id` | *?string* | :heavy_minus_sign: | N/A | tvdb://2337 |

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

@@ -0,0 +1,13 @@
# GetTopWatchedContentMediaContainer
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ |
| `size` | *?int* | :heavy_minus_sign: | N/A | 1 |
| `allowSync` | *?bool* | :heavy_minus_sign: | N/A | true |
| `identifier` | *?string* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
| `mediaTagPrefix` | *?string* | :heavy_minus_sign: | N/A | /system/bundle/media/flags/ |
| `mediaTagVersion` | *?int* | :heavy_minus_sign: | N/A | 1698860922 |
| `metadata` | array<[\LukeHagar\Plex_API\Models\Operations\GetTopWatchedContentMetadata](../../Models/Operations/GetTopWatchedContentMetadata.md)> | :heavy_minus_sign: | N/A | |

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

@@ -0,0 +1,39 @@
# GetTopWatchedContentMetadata
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `ratingKey` | *?string* | :heavy_minus_sign: | N/A | 17 |
| `key` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/17 |
| `guid` | *?string* | :heavy_minus_sign: | N/A | plex://movie/5d77683f6f4521001ea9dc53 |
| `slug` | *?string* | :heavy_minus_sign: | N/A | waterloo-road |
| `studio` | *?string* | :heavy_minus_sign: | N/A | Universal Pictures |
| `type` | *?string* | :heavy_minus_sign: | N/A | movie |
| `title` | *?string* | :heavy_minus_sign: | N/A | Serenity |
| `librarySectionTitle` | *?string* | :heavy_minus_sign: | N/A | Movies |
| `librarySectionID` | *?int* | :heavy_minus_sign: | N/A | 1 |
| `librarySectionKey` | *?string* | :heavy_minus_sign: | N/A | /library/sections/1 |
| `contentRating` | *?string* | :heavy_minus_sign: | N/A | PG-13 |
| `summary` | *?string* | :heavy_minus_sign: | N/A | Serenity continues the story of the TV series it was based upon ("Firefly"). River Tam had a secret - one in which she's not even aware - so dangerous, no one's safe, as an Alliance operative's sent to capture her, and all others are considered irrelevant to his job. |
| `index` | *?int* | :heavy_minus_sign: | N/A | 1 |
| `audienceRating` | *?float* | :heavy_minus_sign: | N/A | 9.1 |
| `year` | *?int* | :heavy_minus_sign: | N/A | 2005 |
| `tagline` | *?string* | :heavy_minus_sign: | N/A | They aim to misbehave. |
| `thumb` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/17/thumb/1705637165 |
| `art` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/17/art/1705637165 |
| `duration` | *?int* | :heavy_minus_sign: | N/A | 141417 |
| `originallyAvailableAt` | [\DateTime](https://www.php.net/manual/en/class.datetime.php) | :heavy_minus_sign: | N/A | 2005-09-29 00:00:00 +0000 UTC |
| `leafCount` | *?int* | :heavy_minus_sign: | N/A | 222 |
| `viewedLeafCount` | *?int* | :heavy_minus_sign: | N/A | 100 |
| `childCount` | *?int* | :heavy_minus_sign: | N/A | 13 |
| `addedAt` | *?int* | :heavy_minus_sign: | N/A | 1705637164 |
| `updatedAt` | *?int* | :heavy_minus_sign: | N/A | 1705637165 |
| `globalViewCount` | *?int* | :heavy_minus_sign: | N/A | 80 |
| `audienceRatingImage` | *?string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright |
| `genre` | array<[\LukeHagar\Plex_API\Models\Operations\GetTopWatchedContentGenre](../../Models/Operations/GetTopWatchedContentGenre.md)> | :heavy_minus_sign: | N/A | |
| `country` | array<[\LukeHagar\Plex_API\Models\Operations\GetTopWatchedContentCountry](../../Models/Operations/GetTopWatchedContentCountry.md)> | :heavy_minus_sign: | N/A | |
| `guids` | array<[\LukeHagar\Plex_API\Models\Operations\GetTopWatchedContentGuids](../../Models/Operations/GetTopWatchedContentGuids.md)> | :heavy_minus_sign: | N/A | |
| `role` | array<[\LukeHagar\Plex_API\Models\Operations\GetTopWatchedContentRole](../../Models/Operations/GetTopWatchedContentRole.md)> | :heavy_minus_sign: | N/A | |
| `user` | array<[\LukeHagar\Plex_API\Models\Operations\User](../../Models/Operations/User.md)> | :heavy_minus_sign: | N/A | |

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

@@ -0,0 +1,9 @@
# GetTopWatchedContentRequest
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- |
| `type` | *int* | :heavy_check_mark: | the library type (1 - movies, 2 - shows, 3 - music) | |
| `includeGuids` | *?int* | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |

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

@@ -0,0 +1,11 @@
# GetTopWatchedContentResponse
## 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` | [?\LukeHagar\Plex_API\Models\Operations\GetTopWatchedContentResponseBody](../../Models/Operations/GetTopWatchedContentResponseBody.md) | :heavy_minus_sign: | The metadata of the library item. |

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

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

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

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

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

@@ -5,7 +5,7 @@
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `filter` | [\LukeHagar\Plex_API\Models\Operations\Filter](../../Models/Operations/Filter.md) | :heavy_check_mark: | Filter |
| `filter` | [\LukeHagar\Plex_API\Models\Operations\PathParamFilter](../../Models/Operations/PathParamFilter.md) | :heavy_check_mark: | Filter |
| `sort` | *?string* | :heavy_minus_sign: | In the format "field:dir". Available fields are "watchlistedAt" (Added At),<br/>"titleSort" (Title), "originallyAvailableAt" (Release Date), or "rating" (Critic Rating).<br/>"dir" can be "asc" or "desc"<br/> |
| `libtype` | [?\LukeHagar\Plex_API\Models\Operations\Libtype](../../Models/Operations/Libtype.md) | :heavy_minus_sign: | The type of library to filter. Can be "movie" or "show", or all if not present.<br/> |
| `maxresults` | *?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/> |

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

@@ -0,0 +1,12 @@
# PathParamFilter
Filter
## Values
| Name | Value |
| ----------- | ----------- |
| `All` | all |
| `Available` | available |
| `Released` | released |

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

@@ -0,0 +1,13 @@
# StatisticsBandwidth
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `accountID` | *?int* | :heavy_minus_sign: | N/A | 238960586 |
| `deviceID` | *?int* | :heavy_minus_sign: | N/A | |
| `timespan` | *?int* | :heavy_minus_sign: | N/A | 6 |
| `at` | *?int* | :heavy_minus_sign: | N/A | 1718387650 |
| `lan` | *?bool* | :heavy_minus_sign: | N/A | true |
| `bytes` | *?int* | :heavy_minus_sign: | N/A | 22 |

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

@@ -0,0 +1,13 @@
# StatisticsResources
## Fields
| Field | Type | Required | Description | Example |
| -------------------------- | -------------------------- | -------------------------- | -------------------------- | -------------------------- |
| `timespan` | *?int* | :heavy_minus_sign: | N/A | 6 |
| `at` | *?int* | :heavy_minus_sign: | N/A | 1718384427 |
| `hostCpuUtilization` | *?float* | :heavy_minus_sign: | N/A | 1.276 |
| `processCpuUtilization` | *?float* | :heavy_minus_sign: | N/A | 0.025 |
| `hostMemoryUtilization` | *?float* | :heavy_minus_sign: | N/A | 17.026 |
| `processMemoryUtilization` | *?float* | :heavy_minus_sign: | N/A | 0.493 |

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

@@ -3,8 +3,6 @@
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
| `id` | *?string* | :heavy_minus_sign: | N/A | 1 |
| `thumb` | *?string* | :heavy_minus_sign: | N/A | https://plex.tv/users/844780fc6f8a26b5/avatar?c=1705853661 |
| `title` | *?string* | :heavy_minus_sign: | N/A | Blindkitty38 |
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `id` | *?int* | :heavy_minus_sign: | N/A | 220 |

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

@@ -18,6 +18,7 @@ API Calls interacting with Plex Media Server Libraries
* [searchLibrary](#searchlibrary) - Search Library
* [getMetadata](#getmetadata) - Get Items Metadata
* [getMetadataChildren](#getmetadatachildren) - Get Items Children
* [getTopWatchedContent](#gettopwatchedcontent) - Get Top Watched Content
* [getOnDeck](#getondeck) - Get On Deck
## getFileHash
@@ -342,7 +343,7 @@ $sdk = Plex_API\PlexAPI::builder()
try {
$response = $sdk->library->getLibraryItems('<value>', Operations\Tag::Genre);
$response = $sdk->library->getLibraryItems('<value>', Operations\Tag::Genre, 1);
if ($response->twoHundredApplicationJsonObject !== null) {
// handle response
@@ -354,10 +355,11 @@ try {
### Parameters
| Parameter | Type | Required | Description |
| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
| `sectionId` | *mixed* | :heavy_check_mark: | the Id of the library to query |
| `tag` | [\LukeHagar\Plex_API\Models\Operations\Tag](../../Models/Operations/Tag.md) | :heavy_check_mark: | A key representing a specific tag within the section. |
| Parameter | Type | Required | Description | Example |
| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
| `sectionId` | *mixed* | :heavy_check_mark: | the Id of the library to query | |
| `tag` | [\LukeHagar\Plex_API\Models\Operations\Tag](../../Models/Operations/Tag.md) | :heavy_check_mark: | A key representing a specific tag within the section. | |
| `includeGuids` | *int* | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |
### Response
@@ -561,7 +563,7 @@ $sdk = Plex_API\PlexAPI::builder()
try {
$response = $sdk->library->getMetadataChildren(1539.14);
$response = $sdk->library->getMetadataChildren(1539.14, '<value>');
if ($response->twoHundredApplicationJsonObject !== null) {
// handle response
@@ -573,9 +575,10 @@ try {
### Parameters
| Parameter | Type | Required | Description |
| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
| `ratingKey` | *float* | :heavy_check_mark: | the id of the library item to return the children of. |
| Parameter | Type | Required | Description |
| ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- |
| `ratingKey` | *float* | :heavy_check_mark: | the id of the library item to return the children of. |
| `includeElements` | *string* | :heavy_minus_sign: | Adds additional elements to the response. Supported types are (Stream)<br/> |
### Response
@@ -583,6 +586,57 @@ try {
**[?\LukeHagar\Plex_API\Models\Operations\GetMetadataChildrenResponse](../../Models/Operations/GetMetadataChildrenResponse.md)**
## getTopWatchedContent
This endpoint will return the top watched content from libraries of a certain type
### Example Usage
```php
<?php
declare(strict_types=1);
require 'vendor/autoload.php';
use \LukeHagar\Plex_API;
use \LukeHagar\Plex_API\Models\Components;
use \LukeHagar\Plex_API\Models\Operations;
$security = new Components\Security();
$security->accessToken = '<YOUR_API_KEY_HERE>';
$sdk = Plex_API\PlexAPI::builder()
->setXPlexClientIdentifier('Postman')
->setSecurity($security)->build();
try {
$response = $sdk->library->getTopWatchedContent(505531, 1);
if ($response->object !== null) {
// handle response
}
} catch (Throwable $e) {
// handle exception
}
```
### Parameters
| Parameter | Type | Required | Description | Example |
| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- |
| `type` | *int* | :heavy_check_mark: | the library type (1 - movies, 2 - shows, 3 - music) | |
| `includeGuids` | *int* | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |
### Response
**[?\LukeHagar\Plex_API\Models\Operations\GetTopWatchedContentResponse](../../Models/Operations/GetTopWatchedContentResponse.md)**
## getOnDeck
This endpoint will return the on deck content.

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

@@ -8,7 +8,7 @@ Operations against the Plex Media Server System.
### Available Operations
* [getServerCapabilities](#getservercapabilities) - Server Capabilities
* [getServerCapabilities](#getservercapabilities) - Get Server Capabilities
* [getServerPreferences](#getserverpreferences) - Get Server Preferences
* [getAvailableClients](#getavailableclients) - Get Available Clients
* [getDevices](#getdevices) - Get Devices
@@ -19,7 +19,7 @@ Operations against the Plex Media Server System.
## getServerCapabilities
Server Capabilities
Get Server Capabilities
### Example Usage

14
docs/sdks/sessions/README.md
View File

@@ -68,6 +68,7 @@ require 'vendor/autoload.php';
use \LukeHagar\Plex_API;
use \LukeHagar\Plex_API\Models\Components;
use \LukeHagar\Plex_API\Models\Operations;
$security = new Components\Security();
$security->accessToken = '<YOUR_API_KEY_HERE>';
@@ -77,7 +78,9 @@ $sdk = Plex_API\PlexAPI::builder()
->setSecurity($security)->build();
try {
$response = $sdk->sessions->getSessionHistory();
$filter = new Operations\Filter();
$response = $sdk->sessions->getSessionHistory('<value>', 1, $filter, 12);
if ($response->twoHundredApplicationJsonObject !== null) {
// handle response
@@ -87,6 +90,15 @@ try {
}
```
### Parameters
| Parameter | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `sort` | *string* | :heavy_minus_sign: | Sorts the results by the specified field followed by the direction (asc, desc)<br/> | |
| `accountId` | *int* | :heavy_minus_sign: | Filter results by those that are related to a specific users id<br/> | 1 |
| `filter` | [\LukeHagar\Plex_API\Models\Operations\Filter](../../Models/Operations/Filter.md) | :heavy_minus_sign: | Filters content by field and direction/equality<br/>(Unknown if viewedAt is the only supported column)<br/> | {<br/>"viewed-at-greater-than": {<br/>"value": "viewedAt\u003e"<br/>},<br/>"viewed-at-greater-than-or-equal-to": {<br/>"value": "viewedAt\u003e=\u003e"<br/>},<br/>"viewed-at-less-than": {<br/>"value": "viewedAt\u003c"<br/>}<br/>} |
| `librarySectionID` | *int* | :heavy_minus_sign: | Filters the results based on the id of a valid library section<br/> | 12 |
### Response

100
docs/sdks/statistics/README.md
View File

@@ -9,6 +9,8 @@ API Calls that perform operations with Plex Media Server Statistics
### Available Operations
* [getStatistics](#getstatistics) - Get Media Statistics
* [getResourcesStatistics](#getresourcesstatistics) - Get Resources Statistics
* [getBandwidthStatistics](#getbandwidthstatistics) - Get Bandwidth Statistics
## getStatistics
@@ -58,3 +60,101 @@ try {
**[?\LukeHagar\Plex_API\Models\Operations\GetStatisticsResponse](../../Models/Operations/GetStatisticsResponse.md)**
## getResourcesStatistics
This will return the resources for the server
### Example Usage
```php
<?php
declare(strict_types=1);
require 'vendor/autoload.php';
use \LukeHagar\Plex_API;
use \LukeHagar\Plex_API\Models\Components;
use \LukeHagar\Plex_API\Models\Operations;
$security = new Components\Security();
$security->accessToken = '<YOUR_API_KEY_HERE>';
$sdk = Plex_API\PlexAPI::builder()
->setXPlexClientIdentifier('Postman')
->setSecurity($security)->build();
try {
$response = $sdk->statistics->getResourcesStatistics(4);
if ($response->twoHundredApplicationJsonObject !== null) {
// handle response
}
} catch (Throwable $e) {
// handle exception
}
```
### Parameters
| Parameter | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| `timespan` | *int* | :heavy_minus_sign: | The timespan to retrieve statistics for<br/>the exact meaning of this parameter is not known<br/> | 4 |
### Response
**[?\LukeHagar\Plex_API\Models\Operations\GetResourcesStatisticsResponse](../../Models/Operations/GetResourcesStatisticsResponse.md)**
## getBandwidthStatistics
This will return the bandwidth statistics for the server
### Example Usage
```php
<?php
declare(strict_types=1);
require 'vendor/autoload.php';
use \LukeHagar\Plex_API;
use \LukeHagar\Plex_API\Models\Components;
use \LukeHagar\Plex_API\Models\Operations;
$security = new Components\Security();
$security->accessToken = '<YOUR_API_KEY_HERE>';
$sdk = Plex_API\PlexAPI::builder()
->setXPlexClientIdentifier('Postman')
->setSecurity($security)->build();
try {
$response = $sdk->statistics->getBandwidthStatistics(4);
if ($response->twoHundredApplicationJsonObject !== null) {
// handle response
}
} catch (Throwable $e) {
// handle exception
}
```
### Parameters
| Parameter | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| `timespan` | *int* | :heavy_minus_sign: | The timespan to retrieve statistics for<br/>the exact meaning of this parameter is not known<br/> | 4 |
### Response
**[?\LukeHagar\Plex_API\Models\Operations\GetBandwidthStatisticsResponse](../../Models/Operations/GetBandwidthStatisticsResponse.md)**

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

@@ -36,7 +36,7 @@ $sdk = Plex_API\PlexAPI::builder()
try {
$request = new Operations\GetWatchlistRequest();
$request->filter = Operations\Filter::Released;
$request->filter = Operations\PathParamFilter::Released;
$request->sort = '<value>';
$request->libtype = Operations\Libtype::Movie;
$request->maxresults = 303056;