mirror of
https://github.com/LukeHagar/plexgo.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 |
|
||||
| ----------------- | ----------------- |
|
||||
| `FilterAll` | all |
|
||||
| `FilterAvailable` | available |
|
||||
| `FilterReleased` | released |
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------- | ----------- | ----------- | ----------- |
|
||||
15
docs/models/operations/getbandwidthstatisticsaccount.md
Normal file
15
docs/models/operations/getbandwidthstatisticsaccount.md
Normal 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
12
docs/models/operations/getbandwidthstatisticsdevice.md
Normal 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 |
|
||||
@@ -0,0 +1,11 @@
|
||||
# GetBandwidthStatisticsMediaContainer
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
|
||||
| `Size` | **int* | :heavy_minus_sign: | N/A | 5497 |
|
||||
| `Device` | [][operations.GetBandwidthStatisticsDevice](../../models/operations/getbandwidthstatisticsdevice.md) | :heavy_minus_sign: | N/A | |
|
||||
| `Account` | [][operations.GetBandwidthStatisticsAccount](../../models/operations/getbandwidthstatisticsaccount.md) | :heavy_minus_sign: | N/A | |
|
||||
| `StatisticsBandwidth` | [][operations.StatisticsBandwidth](../../models/operations/statisticsbandwidth.md) | :heavy_minus_sign: | N/A | |
|
||||
8
docs/models/operations/getbandwidthstatisticsrequest.md
Normal file
8
docs/models/operations/getbandwidthstatisticsrequest.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# GetBandwidthStatisticsRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
|
||||
| `Timespan` | **int64* | :heavy_minus_sign: | The timespan to retrieve statistics for<br/>the exact meaning of this parameter is not known<br/> | 4 |
|
||||
11
docs/models/operations/getbandwidthstatisticsresponse.md
Normal file
11
docs/models/operations/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` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `RawResponse` | [*http.Response](https://pkg.go.dev/net/http#Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `Object` | [*operations.GetBandwidthStatisticsResponseBody](../../models/operations/getbandwidthstatisticsresponsebody.md) | :heavy_minus_sign: | Bandwidth Statistics |
|
||||
10
docs/models/operations/getbandwidthstatisticsresponsebody.md
Normal file
10
docs/models/operations/getbandwidthstatisticsresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetBandwidthStatisticsResponseBody
|
||||
|
||||
Bandwidth Statistics
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
|
||||
| `MediaContainer` | [*operations.GetBandwidthStatisticsMediaContainer](../../models/operations/getbandwidthstatisticsmediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||
@@ -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` | [*operations.LibrarySectionID](../../models/operations/librarysectionid.md) | :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` | [operations.Tag](../../models/operations/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` | [operations.Tag](../../models/operations/tag.md) | :heavy_check_mark: | A key representing a specific tag within the section. | |
|
||||
| `IncludeGuids` | **int64* | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |
|
||||
@@ -3,6 +3,7 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
|
||||
| `RatingKey` | *float64* | :heavy_check_mark: | the id of the library item to return the children of. |
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- |
|
||||
| `RatingKey` | *float64* | :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` | [*time.Time](https://pkg.go.dev/time#Time) | :heavy_minus_sign: | N/A | 2023-04-12 17:00:03 +0000 UTC |
|
||||
| `ExpiresAt` | [*time.Time](https://pkg.go.dev/time#Time) | :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 | |
|
||||
@@ -0,0 +1,9 @@
|
||||
# GetResourcesStatisticsMediaContainer
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
|
||||
| `Size` | **int* | :heavy_minus_sign: | N/A | 5497 |
|
||||
| `StatisticsResources` | [][operations.StatisticsResources](../../models/operations/statisticsresources.md) | :heavy_minus_sign: | N/A | |
|
||||
8
docs/models/operations/getresourcesstatisticsrequest.md
Normal file
8
docs/models/operations/getresourcesstatisticsrequest.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# GetResourcesStatisticsRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
|
||||
| `Timespan` | **int64* | :heavy_minus_sign: | The timespan to retrieve statistics for<br/>the exact meaning of this parameter is not known<br/> | 4 |
|
||||
11
docs/models/operations/getresourcesstatisticsresponse.md
Normal file
11
docs/models/operations/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` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `RawResponse` | [*http.Response](https://pkg.go.dev/net/http#Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `Object` | [*operations.GetResourcesStatisticsResponseBody](../../models/operations/getresourcesstatisticsresponsebody.md) | :heavy_minus_sign: | Resource Statistics |
|
||||
10
docs/models/operations/getresourcesstatisticsresponsebody.md
Normal file
10
docs/models/operations/getresourcesstatisticsresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetResourcesStatisticsResponseBody
|
||||
|
||||
Resource Statistics
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
|
||||
| `MediaContainer` | [*operations.GetResourcesStatisticsMediaContainer](../../models/operations/getresourcesstatisticsmediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||
11
docs/models/operations/getsessionhistoryrequest.md
Normal file
11
docs/models/operations/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` | **int64* | :heavy_minus_sign: | Filter results by those that are related to a specific users id<br/> | 1 |
|
||||
| `Filter` | [*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` | **int64* | :heavy_minus_sign: | Filters the results based on the id of a valid library section<br/> | 12 |
|
||||
@@ -39,6 +39,6 @@
|
||||
| `UpdatedAt` | **int* | :heavy_minus_sign: | N/A | 1705543314 |
|
||||
| `ViewOffset` | **int* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `Media` | [][operations.GetSessionsMedia](../../models/operations/getsessionsmedia.md) | :heavy_minus_sign: | N/A | |
|
||||
| `User` | [*operations.User](../../models/operations/user.md) | :heavy_minus_sign: | N/A | |
|
||||
| `User` | [*operations.GetSessionsUser](../../models/operations/getsessionsuser.md) | :heavy_minus_sign: | N/A | |
|
||||
| `Player` | [*operations.Player](../../models/operations/player.md) | :heavy_minus_sign: | N/A | |
|
||||
| `Session` | [*operations.Session](../../models/operations/session.md) | :heavy_minus_sign: | N/A | |
|
||||
10
docs/models/operations/getsessionsuser.md
Normal file
10
docs/models/operations/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/operations/gettopwatchedcontentcountry.md
Normal file
10
docs/models/operations/gettopwatchedcontentcountry.md
Normal 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
10
docs/models/operations/gettopwatchedcontentgenre.md
Normal 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
8
docs/models/operations/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/operations/gettopwatchedcontentmediacontainer.md
Normal file
13
docs/models/operations/gettopwatchedcontentmediacontainer.md
Normal 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` | [][operations.GetTopWatchedContentMetadata](../../models/operations/gettopwatchedcontentmetadata.md) | :heavy_minus_sign: | N/A | |
|
||||
39
docs/models/operations/gettopwatchedcontentmetadata.md
Normal file
39
docs/models/operations/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` | **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` | **int64* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `AudienceRating` | **float64* | :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` | [*types.Date](../../types/date.md) | :heavy_minus_sign: | N/A | 2005-09-29 00:00:00 +0000 UTC |
|
||||
| `LeafCount` | **int64* | :heavy_minus_sign: | N/A | 222 |
|
||||
| `ViewedLeafCount` | **int64* | :heavy_minus_sign: | N/A | 100 |
|
||||
| `ChildCount` | **int64* | :heavy_minus_sign: | N/A | 13 |
|
||||
| `AddedAt` | **int* | :heavy_minus_sign: | N/A | 1705637164 |
|
||||
| `UpdatedAt` | **int* | :heavy_minus_sign: | N/A | 1705637165 |
|
||||
| `GlobalViewCount` | **int64* | :heavy_minus_sign: | N/A | 80 |
|
||||
| `AudienceRatingImage` | **string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright |
|
||||
| `Genre` | [][operations.GetTopWatchedContentGenre](../../models/operations/gettopwatchedcontentgenre.md) | :heavy_minus_sign: | N/A | |
|
||||
| `Country` | [][operations.GetTopWatchedContentCountry](../../models/operations/gettopwatchedcontentcountry.md) | :heavy_minus_sign: | N/A | |
|
||||
| `Guids` | [][operations.GetTopWatchedContentGuids](../../models/operations/gettopwatchedcontentguids.md) | :heavy_minus_sign: | N/A | |
|
||||
| `Role` | [][operations.GetTopWatchedContentRole](../../models/operations/gettopwatchedcontentrole.md) | :heavy_minus_sign: | N/A | |
|
||||
| `User` | [][operations.User](../../models/operations/user.md) | :heavy_minus_sign: | N/A | |
|
||||
9
docs/models/operations/gettopwatchedcontentrequest.md
Normal file
9
docs/models/operations/gettopwatchedcontentrequest.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# GetTopWatchedContentRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- |
|
||||
| `Type` | *int64* | :heavy_check_mark: | the library type (1 - movies, 2 - shows, 3 - music) | |
|
||||
| `IncludeGuids` | **int64* | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |
|
||||
11
docs/models/operations/gettopwatchedcontentresponse.md
Normal file
11
docs/models/operations/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` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `RawResponse` | [*http.Response](https://pkg.go.dev/net/http#Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `Object` | [*operations.GetTopWatchedContentResponseBody](../../models/operations/gettopwatchedcontentresponsebody.md) | :heavy_minus_sign: | The metadata of the library item. |
|
||||
10
docs/models/operations/gettopwatchedcontentresponsebody.md
Normal file
10
docs/models/operations/gettopwatchedcontentresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetTopWatchedContentResponseBody
|
||||
|
||||
The metadata of the library item.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
|
||||
| `MediaContainer` | [*operations.GetTopWatchedContentMediaContainer](../../models/operations/gettopwatchedcontentmediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||
13
docs/models/operations/gettopwatchedcontentrole.md
Normal file
13
docs/models/operations/gettopwatchedcontentrole.md
Normal 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 |
|
||||
@@ -5,7 +5,7 @@
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `Filter` | [operations.Filter](../../models/operations/filter.md) | :heavy_check_mark: | Filter |
|
||||
| `Filter` | [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` | [*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/> |
|
||||
|
||||
17
docs/models/operations/librarysectionid.md
Normal file
17
docs/models/operations/librarysectionid.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# LibrarySectionID
|
||||
|
||||
|
||||
## Supported Types
|
||||
|
||||
###
|
||||
|
||||
```go
|
||||
librarySectionID := operations.CreateLibrarySectionIDInteger(int64{/* values here */})
|
||||
```
|
||||
|
||||
###
|
||||
|
||||
```go
|
||||
librarySectionID := operations.CreateLibrarySectionIDStr(string{/* values here */})
|
||||
```
|
||||
|
||||
12
docs/models/operations/pathparamfilter.md
Normal file
12
docs/models/operations/pathparamfilter.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# PathParamFilter
|
||||
|
||||
Filter
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| -------------------------- | -------------------------- |
|
||||
| `PathParamFilterAll` | all |
|
||||
| `PathParamFilterAvailable` | available |
|
||||
| `PathParamFilterReleased` | released |
|
||||
13
docs/models/operations/statisticsbandwidth.md
Normal file
13
docs/models/operations/statisticsbandwidth.md
Normal 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` | **int64* | :heavy_minus_sign: | N/A | 6 |
|
||||
| `At` | **int* | :heavy_minus_sign: | N/A | 1718387650 |
|
||||
| `Lan` | **bool* | :heavy_minus_sign: | N/A | true |
|
||||
| `Bytes` | **int64* | :heavy_minus_sign: | N/A | 22 |
|
||||
13
docs/models/operations/statisticsresources.md
Normal file
13
docs/models/operations/statisticsresources.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# StatisticsResources
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------- | -------------------------- | -------------------------- | -------------------------- | -------------------------- |
|
||||
| `Timespan` | **int64* | :heavy_minus_sign: | N/A | 6 |
|
||||
| `At` | **int64* | :heavy_minus_sign: | N/A | 1718384427 |
|
||||
| `HostCPUUtilization` | **float32* | :heavy_minus_sign: | N/A | 1.276 |
|
||||
| `ProcessCPUUtilization` | **float32* | :heavy_minus_sign: | N/A | 0.025 |
|
||||
| `HostMemoryUtilization` | **float32* | :heavy_minus_sign: | N/A | 17.026 |
|
||||
| `ProcessMemoryUtilization` | **float32* | :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` | **int* | :heavy_minus_sign: | N/A | 220 |
|
||||
10
docs/models/sdkerrors/getbandwidthstatisticserrors.md
Normal file
10
docs/models/sdkerrors/getbandwidthstatisticserrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetBandwidthStatisticsErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `Code` | **float64* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `Message` | **string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `Status` | **float64* | :heavy_minus_sign: | N/A | 401 |
|
||||
11
docs/models/sdkerrors/getbandwidthstatisticsresponsebody.md
Normal file
11
docs/models/sdkerrors/getbandwidthstatisticsresponsebody.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# GetBandwidthStatisticsResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
|
||||
| `Errors` | [][sdkerrors.GetBandwidthStatisticsErrors](../../models/sdkerrors/getbandwidthstatisticserrors.md) | :heavy_minus_sign: | N/A |
|
||||
| `RawResponse` | [*http.Response](https://pkg.go.dev/net/http#Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
10
docs/models/sdkerrors/getresourcesstatisticserrors.md
Normal file
10
docs/models/sdkerrors/getresourcesstatisticserrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetResourcesStatisticsErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `Code` | **float64* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `Message` | **string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `Status` | **float64* | :heavy_minus_sign: | N/A | 401 |
|
||||
11
docs/models/sdkerrors/getresourcesstatisticsresponsebody.md
Normal file
11
docs/models/sdkerrors/getresourcesstatisticsresponsebody.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# GetResourcesStatisticsResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
|
||||
| `Errors` | [][sdkerrors.GetResourcesStatisticsErrors](../../models/sdkerrors/getresourcesstatisticserrors.md) | :heavy_minus_sign: | N/A |
|
||||
| `RawResponse` | [*http.Response](https://pkg.go.dev/net/http#Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -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
|
||||
@@ -355,8 +356,10 @@ func main() {
|
||||
var sectionID any = "<value>"
|
||||
|
||||
var tag operations.Tag = operations.TagGenre
|
||||
|
||||
var includeGuids *int64 = plexgo.Int64(1)
|
||||
ctx := context.Background()
|
||||
res, err := s.Library.GetLibraryItems(ctx, sectionID, tag)
|
||||
res, err := s.Library.GetLibraryItems(ctx, sectionID, tag, includeGuids)
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
@@ -368,11 +371,12 @@ func main() {
|
||||
|
||||
### Parameters
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
|
||||
| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. |
|
||||
| `sectionID` | *any* | :heavy_check_mark: | the Id of the library to query |
|
||||
| `tag` | [operations.Tag](../../models/operations/tag.md) | :heavy_check_mark: | A key representing a specific tag within the section. |
|
||||
| Parameter | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
|
||||
| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | |
|
||||
| `sectionID` | *any* | :heavy_check_mark: | the Id of the library to query | |
|
||||
| `tag` | [operations.Tag](../../models/operations/tag.md) | :heavy_check_mark: | A key representing a specific tag within the section. | |
|
||||
| `includeGuids` | **int64* | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |
|
||||
|
||||
|
||||
### Response
|
||||
@@ -573,8 +577,10 @@ func main() {
|
||||
plexgo.WithXPlexClientIdentifier("Postman"),
|
||||
)
|
||||
var ratingKey float64 = 1539.14
|
||||
|
||||
var includeElements *string = plexgo.String("<value>")
|
||||
ctx := context.Background()
|
||||
res, err := s.Library.GetMetadataChildren(ctx, ratingKey)
|
||||
res, err := s.Library.GetMetadataChildren(ctx, ratingKey, includeElements)
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
@@ -586,10 +592,11 @@ func main() {
|
||||
|
||||
### Parameters
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
|
||||
| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. |
|
||||
| `ratingKey` | *float64* | :heavy_check_mark: | the id of the library item to return the children of. |
|
||||
| Parameter | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- |
|
||||
| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. |
|
||||
| `ratingKey` | *float64* | :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
|
||||
@@ -600,6 +607,57 @@ func main() {
|
||||
| sdkerrors.GetMetadataChildrenResponseBody | 401 | application/json |
|
||||
| sdkerrors.SDKError | 4xx-5xx | */* |
|
||||
|
||||
## GetTopWatchedContent
|
||||
|
||||
This endpoint will return the top watched content from libraries of a certain type
|
||||
|
||||
|
||||
### Example Usage
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import(
|
||||
"github.com/LukeHagar/plexgo"
|
||||
"context"
|
||||
"log"
|
||||
)
|
||||
|
||||
func main() {
|
||||
s := plexgo.New(
|
||||
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
|
||||
plexgo.WithXPlexClientIdentifier("Postman"),
|
||||
)
|
||||
var type_ int64 = 505531
|
||||
|
||||
var includeGuids *int64 = plexgo.Int64(1)
|
||||
ctx := context.Background()
|
||||
res, err := s.Library.GetTopWatchedContent(ctx, type_, includeGuids)
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
if res.Object != nil {
|
||||
// handle response
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Parameter | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
|
||||
| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | |
|
||||
| `type_` | *int64* | :heavy_check_mark: | the library type (1 - movies, 2 - shows, 3 - music) | |
|
||||
| `includeGuids` | **int64* | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
**[*operations.GetTopWatchedContentResponse](../../models/operations/gettopwatchedcontentresponse.md), error**
|
||||
| Error Object | Status Code | Content Type |
|
||||
| ------------------ | ------------------ | ------------------ |
|
||||
| sdkerrors.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
|
||||
|
||||
|
||||
@@ -71,6 +71,7 @@ package main
|
||||
|
||||
import(
|
||||
"github.com/LukeHagar/plexgo"
|
||||
"github.com/LukeHagar/plexgo/models/operations"
|
||||
"context"
|
||||
"log"
|
||||
)
|
||||
@@ -80,9 +81,15 @@ func main() {
|
||||
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
|
||||
plexgo.WithXPlexClientIdentifier("Postman"),
|
||||
)
|
||||
var sort *string = plexgo.String("<value>")
|
||||
|
||||
var accountID *int64 = plexgo.Int64(1)
|
||||
|
||||
var filter *operations.Filter = &operations.Filter{}
|
||||
|
||||
var librarySectionID *int64 = plexgo.Int64(12)
|
||||
ctx := context.Background()
|
||||
res, err := s.Sessions.GetSessionHistory(ctx)
|
||||
res, err := s.Sessions.GetSessionHistory(ctx, sort, accountID, filter, librarySectionID)
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
@@ -94,9 +101,13 @@ func main() {
|
||||
|
||||
### Parameters
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
|
||||
| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. |
|
||||
| Parameter | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | |
|
||||
| `sort` | **string* | :heavy_minus_sign: | Sorts the results by the specified field followed by the direction (asc, desc)<br/> | |
|
||||
| `accountID` | **int64* | :heavy_minus_sign: | Filter results by those that are related to a specific users id<br/> | 1 |
|
||||
| `filter` | [*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` | **int64* | :heavy_minus_sign: | Filters the results based on the id of a valid library section<br/> | 12 |
|
||||
|
||||
|
||||
### 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
|
||||
|
||||
@@ -57,3 +59,99 @@ func main() {
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| sdkerrors.GetStatisticsResponseBody | 401 | application/json |
|
||||
| sdkerrors.SDKError | 4xx-5xx | */* |
|
||||
|
||||
## GetResourcesStatistics
|
||||
|
||||
This will return the resources for the server
|
||||
|
||||
### Example Usage
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import(
|
||||
"github.com/LukeHagar/plexgo"
|
||||
"context"
|
||||
"log"
|
||||
)
|
||||
|
||||
func main() {
|
||||
s := plexgo.New(
|
||||
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
|
||||
plexgo.WithXPlexClientIdentifier("Postman"),
|
||||
)
|
||||
var timespan *int64 = plexgo.Int64(4)
|
||||
ctx := context.Background()
|
||||
res, err := s.Statistics.GetResourcesStatistics(ctx, timespan)
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
if res.Object != nil {
|
||||
// handle response
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Parameter | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
|
||||
| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | |
|
||||
| `timespan` | **int64* | :heavy_minus_sign: | The timespan to retrieve statistics for<br/>the exact meaning of this parameter is not known<br/> | 4 |
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
**[*operations.GetResourcesStatisticsResponse](../../models/operations/getresourcesstatisticsresponse.md), error**
|
||||
| Error Object | Status Code | Content Type |
|
||||
| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
|
||||
| sdkerrors.GetResourcesStatisticsResponseBody | 401 | application/json |
|
||||
| sdkerrors.SDKError | 4xx-5xx | */* |
|
||||
|
||||
## GetBandwidthStatistics
|
||||
|
||||
This will return the bandwidth statistics for the server
|
||||
|
||||
### Example Usage
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import(
|
||||
"github.com/LukeHagar/plexgo"
|
||||
"context"
|
||||
"log"
|
||||
)
|
||||
|
||||
func main() {
|
||||
s := plexgo.New(
|
||||
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
|
||||
plexgo.WithXPlexClientIdentifier("Postman"),
|
||||
)
|
||||
var timespan *int64 = plexgo.Int64(4)
|
||||
ctx := context.Background()
|
||||
res, err := s.Statistics.GetBandwidthStatistics(ctx, timespan)
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
if res.Object != nil {
|
||||
// handle response
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Parameter | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
|
||||
| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | |
|
||||
| `timespan` | **int64* | :heavy_minus_sign: | The timespan to retrieve statistics for<br/>the exact meaning of this parameter is not known<br/> | 4 |
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
**[*operations.GetBandwidthStatisticsResponse](../../models/operations/getbandwidthstatisticsresponse.md), error**
|
||||
| Error Object | Status Code | Content Type |
|
||||
| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
|
||||
| sdkerrors.GetBandwidthStatisticsResponseBody | 401 | application/json |
|
||||
| sdkerrors.SDKError | 4xx-5xx | */* |
|
||||
|
||||
@@ -32,7 +32,7 @@ func main() {
|
||||
plexgo.WithXPlexClientIdentifier("Postman"),
|
||||
)
|
||||
request := operations.GetWatchlistRequest{
|
||||
Filter: operations.FilterReleased,
|
||||
Filter: operations.PathParamFilterReleased,
|
||||
XPlexToken: "<value>",
|
||||
}
|
||||
ctx := context.Background()
|
||||
|
||||
Reference in New Issue
Block a user