mirror of
https://github.com/LukeHagar/plexjs.git
synced 2025-12-06 04:20:46 +00:00
ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.314.2
This commit is contained in:
speakeasybot
@@ -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/getbandwidthstatisticsaccount.md
Normal file
15
docs/models/getbandwidthstatisticsaccount.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# GetBandwidthStatisticsAccount
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
|
||||
| `id` | *number* | :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` | *boolean* | :heavy_minus_sign: | N/A | true |
|
||||
| `defaultSubtitleLanguage` | *string* | :heavy_minus_sign: | N/A | en |
|
||||
| `subtitleMode` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `thumb` | *string* | :heavy_minus_sign: | N/A | https://plex.tv/users/50d83634246da1de/avatar?c=1707110967 |
|
||||
12
docs/models/getbandwidthstatisticsdevice.md
Normal file
12
docs/models/getbandwidthstatisticsdevice.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# GetBandwidthStatisticsDevice
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- |
|
||||
| `id` | *number* | :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` | *number* | :heavy_minus_sign: | N/A | 1706470556 |
|
||||
10
docs/models/getbandwidthstatisticserrors.md
Normal file
10
docs/models/getbandwidthstatisticserrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetBandwidthStatisticsErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
||||
11
docs/models/getbandwidthstatisticsmediacontainer.md
Normal file
11
docs/models/getbandwidthstatisticsmediacontainer.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# GetBandwidthStatisticsMediaContainer
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
|
||||
| `size` | *number* | :heavy_minus_sign: | N/A | 5497 |
|
||||
| `device` | [models.GetBandwidthStatisticsDevice](../models/getbandwidthstatisticsdevice.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `account` | [models.GetBandwidthStatisticsAccount](../models/getbandwidthstatisticsaccount.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `statisticsBandwidth` | [models.StatisticsBandwidth](../models/statisticsbandwidth.md)[] | :heavy_minus_sign: | N/A | |
|
||||
8
docs/models/getbandwidthstatisticsrequest.md
Normal file
8
docs/models/getbandwidthstatisticsrequest.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# GetBandwidthStatisticsRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
|
||||
| `timespan` | *number* | :heavy_minus_sign: | The timespan to retrieve statistics for<br/>the exact meaning of this parameter is not known<br/> | 4 |
|
||||
11
docs/models/getbandwidthstatisticsresponse.md
Normal file
11
docs/models/getbandwidthstatisticsresponse.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# GetBandwidthStatisticsResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [models.GetBandwidthStatisticsResponseBody](../models/getbandwidthstatisticsresponsebody.md) | :heavy_minus_sign: | Bandwidth Statistics |
|
||||
10
docs/models/getbandwidthstatisticsresponsebody.md
Normal file
10
docs/models/getbandwidthstatisticsresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetBandwidthStatisticsResponseBody
|
||||
|
||||
Bandwidth Statistics
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
|
||||
| `mediaContainer` | [models.GetBandwidthStatisticsMediaContainer](../models/getbandwidthstatisticsmediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||
11
docs/models/getbandwidthstatisticsstatisticsresponsebody.md
Normal file
11
docs/models/getbandwidthstatisticsstatisticsresponsebody.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# GetBandwidthStatisticsStatisticsResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
|
||||
| `errors` | [models.GetBandwidthStatisticsErrors](../models/getbandwidthstatisticserrors.md)[] | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -9,7 +9,7 @@
|
||||
| `allowSync` | *boolean* | :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` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `librarySectionID` | *models.LibrarySectionID* | :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/ |
|
||||
|
||||
@@ -3,7 +3,8 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
|
||||
| `sectionId` | *any* | :heavy_check_mark: | the Id of the library to query |
|
||||
| `tag` | [models.Tag](../models/tag.md) | :heavy_check_mark: | A key representing a specific tag within the section. |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
|
||||
| `sectionId` | *any* | :heavy_check_mark: | the Id of the library to query | |
|
||||
| `tag` | [models.Tag](../models/tag.md) | :heavy_check_mark: | A key representing a specific tag within the section. | |
|
||||
| `includeGuids` | *number* | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |
|
||||
@@ -3,6 +3,7 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
|
||||
| `ratingKey` | *number* | :heavy_check_mark: | the id of the library item to return the children of. |
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- |
|
||||
| `ratingKey` | *number* | :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/> |
|
||||
@@ -5,4 +5,4 @@
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `xPlexClientIdentifier` | *string* | :heavy_check_mark: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | Postman |
|
||||
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | Postman |
|
||||
@@ -18,4 +18,4 @@ The Pin
|
||||
| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A | 2023-04-12 17:00:03 +0000 UTC |
|
||||
| `expiresAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :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` | *boolean* | :heavy_minus_sign: | N/A | |
|
||||
10
docs/models/getresourcesstatisticserrors.md
Normal file
10
docs/models/getresourcesstatisticserrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetResourcesStatisticsErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
||||
9
docs/models/getresourcesstatisticsmediacontainer.md
Normal file
9
docs/models/getresourcesstatisticsmediacontainer.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# GetResourcesStatisticsMediaContainer
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- |
|
||||
| `size` | *number* | :heavy_minus_sign: | N/A | 5497 |
|
||||
| `statisticsResources` | [models.StatisticsResources](../models/statisticsresources.md)[] | :heavy_minus_sign: | N/A | |
|
||||
8
docs/models/getresourcesstatisticsrequest.md
Normal file
8
docs/models/getresourcesstatisticsrequest.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# GetResourcesStatisticsRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
|
||||
| `timespan` | *number* | :heavy_minus_sign: | The timespan to retrieve statistics for<br/>the exact meaning of this parameter is not known<br/> | 4 |
|
||||
11
docs/models/getresourcesstatisticsresponse.md
Normal file
11
docs/models/getresourcesstatisticsresponse.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# GetResourcesStatisticsResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [models.GetResourcesStatisticsResponseBody](../models/getresourcesstatisticsresponsebody.md) | :heavy_minus_sign: | Resource Statistics |
|
||||
10
docs/models/getresourcesstatisticsresponsebody.md
Normal file
10
docs/models/getresourcesstatisticsresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetResourcesStatisticsResponseBody
|
||||
|
||||
Resource Statistics
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
|
||||
| `mediaContainer` | [models.GetResourcesStatisticsMediaContainer](../models/getresourcesstatisticsmediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||
11
docs/models/getresourcesstatisticsstatisticsresponsebody.md
Normal file
11
docs/models/getresourcesstatisticsstatisticsresponsebody.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# GetResourcesStatisticsStatisticsResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
|
||||
| `errors` | [models.GetResourcesStatisticsErrors](../models/getresourcesstatisticserrors.md)[] | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
11
docs/models/getsessionhistoryrequest.md
Normal file
11
docs/models/getsessionhistoryrequest.md
Normal 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` | *number* | :heavy_minus_sign: | Filter results by those that are related to a specific users id<br/> | 1 |
|
||||
| `filter` | [models.Filter](../models/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` | *number* | :heavy_minus_sign: | Filters the results based on the id of a valid library section<br/> | 12 |
|
||||
@@ -39,6 +39,6 @@
|
||||
| `updatedAt` | *number* | :heavy_minus_sign: | N/A | 1705543314 |
|
||||
| `viewOffset` | *number* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `media` | [models.GetSessionsMedia](../models/getsessionsmedia.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `user` | [models.User](../models/user.md) | :heavy_minus_sign: | N/A | |
|
||||
| `user` | [models.GetSessionsUser](../models/getsessionsuser.md) | :heavy_minus_sign: | N/A | |
|
||||
| `player` | [models.Player](../models/player.md) | :heavy_minus_sign: | N/A | |
|
||||
| `session` | [models.Session](../models/session.md) | :heavy_minus_sign: | N/A | |
|
||||
10
docs/models/getsessionsuser.md
Normal file
10
docs/models/getsessionsuser.md
Normal 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 |
|
||||
@@ -5,4 +5,4 @@
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `xPlexClientIdentifier` | *string* | :heavy_check_mark: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | Postman |
|
||||
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | Postman |
|
||||
10
docs/models/gettopwatchedcontentcountry.md
Normal file
10
docs/models/gettopwatchedcontentcountry.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetTopWatchedContentCountry
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ |
|
||||
| `id` | *number* | :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/gettopwatchedcontentgenre.md
Normal file
10
docs/models/gettopwatchedcontentgenre.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetTopWatchedContentGenre
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `id` | *number* | :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/gettopwatchedcontentguids.md
Normal file
8
docs/models/gettopwatchedcontentguids.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# GetTopWatchedContentGuids
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `id` | *string* | :heavy_minus_sign: | N/A | tvdb://2337 |
|
||||
13
docs/models/gettopwatchedcontentmediacontainer.md
Normal file
13
docs/models/gettopwatchedcontentmediacontainer.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# GetTopWatchedContentMediaContainer
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
|
||||
| `size` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `allowSync` | *boolean* | :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` | *number* | :heavy_minus_sign: | N/A | 1698860922 |
|
||||
| `metadata` | [models.GetTopWatchedContentMetadata](../models/gettopwatchedcontentmetadata.md)[] | :heavy_minus_sign: | N/A | |
|
||||
39
docs/models/gettopwatchedcontentmetadata.md
Normal file
39
docs/models/gettopwatchedcontentmetadata.md
Normal 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` | *number* | :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` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `audienceRating` | *number* | :heavy_minus_sign: | N/A | 9.1 |
|
||||
| `year` | *number* | :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` | *number* | :heavy_minus_sign: | N/A | 141417 |
|
||||
| `originallyAvailableAt` | [RFCDate](../types/rfcdate.md) | :heavy_minus_sign: | N/A | 2005-09-29 00:00:00 +0000 UTC |
|
||||
| `leafCount` | *number* | :heavy_minus_sign: | N/A | 222 |
|
||||
| `viewedLeafCount` | *number* | :heavy_minus_sign: | N/A | 100 |
|
||||
| `childCount` | *number* | :heavy_minus_sign: | N/A | 13 |
|
||||
| `addedAt` | *number* | :heavy_minus_sign: | N/A | 1705637164 |
|
||||
| `updatedAt` | *number* | :heavy_minus_sign: | N/A | 1705637165 |
|
||||
| `globalViewCount` | *number* | :heavy_minus_sign: | N/A | 80 |
|
||||
| `audienceRatingImage` | *string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright |
|
||||
| `genre` | [models.GetTopWatchedContentGenre](../models/gettopwatchedcontentgenre.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `country` | [models.GetTopWatchedContentCountry](../models/gettopwatchedcontentcountry.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `guids` | [models.GetTopWatchedContentGuids](../models/gettopwatchedcontentguids.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `role` | [models.GetTopWatchedContentRole](../models/gettopwatchedcontentrole.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `user` | [models.User](../models/user.md)[] | :heavy_minus_sign: | N/A | |
|
||||
9
docs/models/gettopwatchedcontentrequest.md
Normal file
9
docs/models/gettopwatchedcontentrequest.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# GetTopWatchedContentRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- |
|
||||
| `type` | *number* | :heavy_check_mark: | the library type (1 - movies, 2 - shows, 3 - music) | |
|
||||
| `includeGuids` | *number* | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |
|
||||
11
docs/models/gettopwatchedcontentresponse.md
Normal file
11
docs/models/gettopwatchedcontentresponse.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# GetTopWatchedContentResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [models.GetTopWatchedContentResponseBody](../models/gettopwatchedcontentresponsebody.md) | :heavy_minus_sign: | The metadata of the library item. |
|
||||
10
docs/models/gettopwatchedcontentresponsebody.md
Normal file
10
docs/models/gettopwatchedcontentresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetTopWatchedContentResponseBody
|
||||
|
||||
The metadata of the library item.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
|
||||
| `mediaContainer` | [models.GetTopWatchedContentMediaContainer](../models/gettopwatchedcontentmediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||
13
docs/models/gettopwatchedcontentrole.md
Normal file
13
docs/models/gettopwatchedcontentrole.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# GetTopWatchedContentRole
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||
| `id` | *number* | :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 |
|
||||
@@ -5,7 +5,7 @@
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `filter` | [models.Filter](../models/filter.md) | :heavy_check_mark: | Filter |
|
||||
| `filter` | [models.PathParamFilter](../models/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` | [models.Libtype](../models/libtype.md) | :heavy_minus_sign: | The type of library to filter. Can be "movie" or "show", or all if not present.<br/> |
|
||||
| `maxresults` | *number* | :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/> |
|
||||
|
||||
17
docs/models/librarysectionid.md
Normal file
17
docs/models/librarysectionid.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# LibrarySectionID
|
||||
|
||||
|
||||
## Supported Types
|
||||
|
||||
### `number`
|
||||
|
||||
```typescript
|
||||
const value: number = /* values here */
|
||||
```
|
||||
|
||||
### `string`
|
||||
|
||||
```typescript
|
||||
const value: string = /* values here */
|
||||
```
|
||||
|
||||
12
docs/models/pathparamfilter.md
Normal file
12
docs/models/pathparamfilter.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# PathParamFilter
|
||||
|
||||
Filter
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ----------- | ----------- |
|
||||
| `All` | all |
|
||||
| `Available` | available |
|
||||
| `Released` | released |
|
||||
13
docs/models/statisticsbandwidth.md
Normal file
13
docs/models/statisticsbandwidth.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# StatisticsBandwidth
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `accountID` | *number* | :heavy_minus_sign: | N/A | 238960586 |
|
||||
| `deviceID` | *number* | :heavy_minus_sign: | N/A | |
|
||||
| `timespan` | *number* | :heavy_minus_sign: | N/A | 6 |
|
||||
| `at` | *number* | :heavy_minus_sign: | N/A | 1718387650 |
|
||||
| `lan` | *boolean* | :heavy_minus_sign: | N/A | true |
|
||||
| `bytes` | *number* | :heavy_minus_sign: | N/A | 22 |
|
||||
13
docs/models/statisticsresources.md
Normal file
13
docs/models/statisticsresources.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# StatisticsResources
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------- | -------------------------- | -------------------------- | -------------------------- | -------------------------- |
|
||||
| `timespan` | *number* | :heavy_minus_sign: | N/A | 6 |
|
||||
| `at` | *number* | :heavy_minus_sign: | N/A | 1718384427 |
|
||||
| `hostCpuUtilization` | *number* | :heavy_minus_sign: | N/A | 1.276 |
|
||||
| `processCpuUtilization` | *number* | :heavy_minus_sign: | N/A | 0.025 |
|
||||
| `hostMemoryUtilization` | *number* | :heavy_minus_sign: | N/A | 17.026 |
|
||||
| `processMemoryUtilization` | *number* | :heavy_minus_sign: | N/A | 0.493 |
|
||||
@@ -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` | *number* | :heavy_minus_sign: | N/A | 220 |
|
||||
@@ -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
|
||||
@@ -316,7 +317,7 @@ const plexAPI = new PlexAPI({
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await plexAPI.library.getLibraryItems("<value>", Tag.Genre);
|
||||
const result = await plexAPI.library.getLibraryItems("<value>", Tag.Genre, 1);
|
||||
|
||||
// Handle the result
|
||||
console.log(result)
|
||||
@@ -327,12 +328,13 @@ run();
|
||||
|
||||
### Parameters
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `sectionId` | *any* | :heavy_check_mark: | the Id of the library to query |
|
||||
| `tag` | [models.Tag](../../models/tag.md) | :heavy_check_mark: | A key representing a specific tag within the section. |
|
||||
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
||||
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
||||
| Parameter | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `sectionId` | *any* | :heavy_check_mark: | the Id of the library to query | |
|
||||
| `tag` | [models.Tag](../../models/tag.md) | :heavy_check_mark: | A key representing a specific tag within the section. | |
|
||||
| `includeGuids` | *number* | :heavy_minus_sign: | Adds the Guids object to the response<br/> | [object Object] |
|
||||
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | |
|
||||
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | |
|
||||
|
||||
|
||||
### Response
|
||||
@@ -511,7 +513,7 @@ const plexAPI = new PlexAPI({
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await plexAPI.library.getMetadataChildren(1539.14);
|
||||
const result = await plexAPI.library.getMetadataChildren(1539.14, "<value>");
|
||||
|
||||
// Handle the result
|
||||
console.log(result)
|
||||
@@ -525,6 +527,7 @@ run();
|
||||
| Parameter | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `ratingKey` | *number* | :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/> |
|
||||
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
||||
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
||||
|
||||
@@ -539,6 +542,50 @@ run();
|
||||
| models.GetMetadataChildrenLibraryResponseBody | 401 | application/json |
|
||||
| models.SDKError | 4xx-5xx | */* |
|
||||
|
||||
## getTopWatchedContent
|
||||
|
||||
This endpoint will return the top watched content from libraries of a certain type
|
||||
|
||||
|
||||
### Example Usage
|
||||
|
||||
```typescript
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await plexAPI.library.getTopWatchedContent(505531, 1);
|
||||
|
||||
// Handle the result
|
||||
console.log(result)
|
||||
}
|
||||
|
||||
run();
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Parameter | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `type` | *number* | :heavy_check_mark: | the library type (1 - movies, 2 - shows, 3 - music) | |
|
||||
| `includeGuids` | *number* | :heavy_minus_sign: | Adds the Guids object to the response<br/> | [object Object] |
|
||||
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | |
|
||||
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | |
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
**Promise\<[models.GetTopWatchedContentResponse](../../models/gettopwatchedcontentresponse.md)\>**
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| --------------- | --------------- | --------------- |
|
||||
| models.SDKError | 4xx-5xx | */* |
|
||||
|
||||
## getOnDeck
|
||||
|
||||
This endpoint will return the on deck content.
|
||||
|
||||
@@ -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
|
||||
|
||||
|
||||
@@ -70,7 +70,7 @@ const plexAPI = new PlexAPI({
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await plexAPI.sessions.getSessionHistory();
|
||||
const result = await plexAPI.sessions.getSessionHistory("<value>", 1, {}, 12);
|
||||
|
||||
// Handle the result
|
||||
console.log(result)
|
||||
@@ -81,10 +81,14 @@ run();
|
||||
|
||||
### Parameters
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
||||
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
||||
| 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` | *number* | :heavy_minus_sign: | Filter results by those that are related to a specific users id<br/> | [object Object] |
|
||||
| `filter` | [models.Filter](../../models/filter.md) | :heavy_minus_sign: | Filters content by field and direction/equality<br/>(Unknown if viewedAt is the only supported column)<br/> | [object Object] |
|
||||
| `librarySectionID` | *number* | :heavy_minus_sign: | Filters the results based on the id of a valid library section<br/> | [object Object] |
|
||||
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | |
|
||||
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | |
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -52,3 +54,89 @@ run();
|
||||
| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ |
|
||||
| models.GetStatisticsStatisticsResponseBody | 401 | application/json |
|
||||
| models.SDKError | 4xx-5xx | */* |
|
||||
|
||||
## getResourcesStatistics
|
||||
|
||||
This will return the resources for the server
|
||||
|
||||
### Example Usage
|
||||
|
||||
```typescript
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await plexAPI.statistics.getResourcesStatistics(4);
|
||||
|
||||
// Handle the result
|
||||
console.log(result)
|
||||
}
|
||||
|
||||
run();
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Parameter | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `timespan` | *number* | :heavy_minus_sign: | The timespan to retrieve statistics for<br/>the exact meaning of this parameter is not known<br/> | [object Object] |
|
||||
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | |
|
||||
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | |
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
**Promise\<[models.GetResourcesStatisticsResponse](../../models/getresourcesstatisticsresponse.md)\>**
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- |
|
||||
| models.GetResourcesStatisticsStatisticsResponseBody | 401 | application/json |
|
||||
| models.SDKError | 4xx-5xx | */* |
|
||||
|
||||
## getBandwidthStatistics
|
||||
|
||||
This will return the bandwidth statistics for the server
|
||||
|
||||
### Example Usage
|
||||
|
||||
```typescript
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await plexAPI.statistics.getBandwidthStatistics(4);
|
||||
|
||||
// Handle the result
|
||||
console.log(result)
|
||||
}
|
||||
|
||||
run();
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Parameter | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `timespan` | *number* | :heavy_minus_sign: | The timespan to retrieve statistics for<br/>the exact meaning of this parameter is not known<br/> | [object Object] |
|
||||
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | |
|
||||
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | |
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
**Promise\<[models.GetBandwidthStatisticsResponse](../../models/getbandwidthstatisticsresponse.md)\>**
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- |
|
||||
| models.GetBandwidthStatisticsStatisticsResponseBody | 401 | application/json |
|
||||
| models.SDKError | 4xx-5xx | */* |
|
||||
|
||||
@@ -17,7 +17,7 @@ Get User Watchlist
|
||||
### Example Usage
|
||||
|
||||
```typescript
|
||||
import { Filter, PlexAPI } from "@lukehagar/plexjs";
|
||||
import { PathParamFilter, PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
@@ -26,7 +26,7 @@ const plexAPI = new PlexAPI({
|
||||
|
||||
async function run() {
|
||||
const result = await plexAPI.watchlist.getWatchlist({
|
||||
filter: Filter.Released,
|
||||
filter: PathParamFilter.Released,
|
||||
xPlexToken: "<value>",
|
||||
});
|
||||
|
||||
|
||||
Reference in New Issue
Block a user