LukeParke/plexruby
1
0
Fork 0
mirror of https://github.com/LukeHagar/plexruby.git synced 2025-12-09 20:57:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.314.2

Browse Source
This commit is contained in:
speakeasybot
2024-06-22 00:11:30 +00:00
parent ed203455dd
commit 56086a732d
93 changed files with 2044 additions and 372 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
docs/models/operations/filter.md
View File

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

15
docs/models/operations/getbandwidthstatisticsaccount.md Normal file
View File

@@ -0,0 +1,15 @@
# GetBandwidthStatisticsAccount
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
| `id` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 238960586 |
| `key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /accounts/238960586 |
| `name` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Diane |
| `default_audio_language` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | en |
| `auto_select_audio` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | true |
| `default_subtitle_language` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | en |
| `subtitle_mode` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1 |
| `thumb` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | https://plex.tv/users/50d83634246da1de/avatar?c=1707110967 |

12
docs/models/operations/getbandwidthstatisticsdevice.md Normal file
View File

@@ -0,0 +1,12 @@
# GetBandwidthStatisticsDevice
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- |
| `id` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 208 |
| `name` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Roku Express |
| `platform` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Roku |
| `client_identifier` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 793095d235660625108ef785cc7646e9 |
| `created_at` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1706470556 |

10
docs/models/operations/getbandwidthstatisticserrors.md Normal file
View File

@@ -0,0 +1,10 @@
# GetBandwidthStatisticsErrors
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
| `code` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 1001 |
| `message` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | User could not be authenticated |
| `status` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 401 |

11
docs/models/operations/getbandwidthstatisticsmediacontainer.md Normal file
View File

@@ -0,0 +1,11 @@
# GetBandwidthStatisticsMediaContainer
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
| `size` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 5497 |
| `device` | T::Array<[::OpenApiSDK::Operations::GetBandwidthStatisticsDevice](../../models/operations/getbandwidthstatisticsdevice.md)> | :heavy_minus_sign: | N/A | |
| `account` | T::Array<[::OpenApiSDK::Operations::GetBandwidthStatisticsAccount](../../models/operations/getbandwidthstatisticsaccount.md)> | :heavy_minus_sign: | N/A | |
| `statistics_bandwidth` | T::Array<[::OpenApiSDK::Operations::StatisticsBandwidth](../../models/operations/statisticsbandwidth.md)> | :heavy_minus_sign: | N/A | |

8
docs/models/operations/getbandwidthstatisticsrequest.md Normal file
View File

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

12
docs/models/operations/getbandwidthstatisticsresponse.md Normal file
View File

@@ -0,0 +1,12 @@
# GetBandwidthStatisticsResponse
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `content_type` | *::String* | :heavy_check_mark: | HTTP response content type for this operation |
| `status_code` | *::Integer* | :heavy_check_mark: | HTTP response status code for this operation |
| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `two_hundred_application_json_object` | [T.nilable(::OpenApiSDK::Operations::GetBandwidthStatisticsResponseBody)](../../models/operations/getbandwidthstatisticsresponsebody.md) | :heavy_minus_sign: | Bandwidth Statistics |
| `four_hundred_and_one_application_json_object` | [T.nilable(::OpenApiSDK::Operations::GetBandwidthStatisticsStatisticsResponseBody)](../../models/operations/getbandwidthstatisticsstatisticsresponsebody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |

10
docs/models/operations/getbandwidthstatisticsresponsebody.md Normal file
View File

@@ -0,0 +1,10 @@
# GetBandwidthStatisticsResponseBody
Bandwidth Statistics
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| `media_container` | [T.nilable(::OpenApiSDK::Operations::GetBandwidthStatisticsMediaContainer)](../../models/operations/getbandwidthstatisticsmediacontainer.md) | :heavy_minus_sign: | N/A |

10
docs/models/operations/getbandwidthstatisticsstatisticsresponsebody.md Normal file
View File

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

2
docs/models/operations/getlibraryitemsmediacontainer.md
View File

@@ -9,7 +9,7 @@
| `allow_sync` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | true |
| `art` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /:/resources/movie-fanart.jpg |
| `identifier` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
| `library_section_id` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1 |
| `library_section_id` | *T.nilable(::Object)* | :heavy_minus_sign: | N/A | |
| `library_section_title` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Movies |
| `library_section_uuid` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
| `media_tag_prefix` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /system/bundle/media/flags/ |

9
docs/models/operations/getlibraryitemsrequest.md
View File

@@ -3,7 +3,8 @@
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- |
| `section_id` | *::Object* | :heavy_check_mark: | the Id of the library to query |
| `tag` | [::OpenApiSDK::Operations::Tag](../../models/operations/tag.md) | :heavy_check_mark: | A key representing a specific tag within the section. |
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- |
| `section_id` | *::Object* | :heavy_check_mark: | the Id of the library to query | |
| `tag` | [::OpenApiSDK::Operations::Tag](../../models/operations/tag.md) | :heavy_check_mark: | A key representing a specific tag within the section. | |
| `include_guids` | *T.nilable(::Integer)* | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |

7
docs/models/operations/getmetadatachildrenrequest.md
View File

@@ -3,6 +3,7 @@
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
| `rating_key` | *::Float* | :heavy_check_mark: | the id of the library item to return the children of. |
| Field | Type | Required | Description |
| ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- |
| `rating_key` | *::Float* | :heavy_check_mark: | the id of the library item to return the children of. |
| `include_elements` | *T.nilable(::String)* | :heavy_minus_sign: | Adds additional elements to the response. Supported types are (Stream)<br/> |

2
docs/models/operations/getpinresponsebody.md
View File

@@ -18,4 +18,4 @@ The Pin
| `created_at` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :heavy_minus_sign: | N/A | 2023-04-12 17:00:03 +0000 UTC |
| `expires_at` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :heavy_minus_sign: | N/A | 2023-04-12 17:30:03 +0000 UTC |
| `auth_token` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | |
| `new_registration` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | |
| `new_registration` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | |

10
docs/models/operations/getresourcesstatisticserrors.md Normal file
View File

@@ -0,0 +1,10 @@
# GetResourcesStatisticsErrors
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
| `code` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 1001 |
| `message` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | User could not be authenticated |
| `status` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 401 |

9
docs/models/operations/getresourcesstatisticsmediacontainer.md Normal file
View File

@@ -0,0 +1,9 @@
# GetResourcesStatisticsMediaContainer
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
| `size` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 5497 |
| `statistics_resources` | T::Array<[::OpenApiSDK::Operations::StatisticsResources](../../models/operations/statisticsresources.md)> | :heavy_minus_sign: | N/A | |

8
docs/models/operations/getresourcesstatisticsrequest.md Normal file
View File

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

12
docs/models/operations/getresourcesstatisticsresponse.md Normal file
View File

@@ -0,0 +1,12 @@
# GetResourcesStatisticsResponse
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `content_type` | *::String* | :heavy_check_mark: | HTTP response content type for this operation |
| `status_code` | *::Integer* | :heavy_check_mark: | HTTP response status code for this operation |
| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `two_hundred_application_json_object` | [T.nilable(::OpenApiSDK::Operations::GetResourcesStatisticsResponseBody)](../../models/operations/getresourcesstatisticsresponsebody.md) | :heavy_minus_sign: | Resource Statistics |
| `four_hundred_and_one_application_json_object` | [T.nilable(::OpenApiSDK::Operations::GetResourcesStatisticsStatisticsResponseBody)](../../models/operations/getresourcesstatisticsstatisticsresponsebody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |

10
docs/models/operations/getresourcesstatisticsresponsebody.md Normal file
View File

@@ -0,0 +1,10 @@
# GetResourcesStatisticsResponseBody
Resource Statistics
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| `media_container` | [T.nilable(::OpenApiSDK::Operations::GetResourcesStatisticsMediaContainer)](../../models/operations/getresourcesstatisticsmediacontainer.md) | :heavy_minus_sign: | N/A |

10
docs/models/operations/getresourcesstatisticsstatisticsresponsebody.md Normal file
View File

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

11
docs/models/operations/getsessionhistoryrequest.md Normal file
View File

@@ -0,0 +1,11 @@
# GetSessionHistoryRequest
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `sort` | *T.nilable(::String)* | :heavy_minus_sign: | Sorts the results by the specified field followed by the direction (asc, desc)<br/> | |
| `account_id` | *T.nilable(::Integer)* | :heavy_minus_sign: | Filter results by those that are related to a specific users id<br/> | 1 |
| `filter` | [T.nilable(::OpenApiSDK::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/>} |
| `library_section_id` | *T.nilable(::Integer)* | :heavy_minus_sign: | Filters the results based on the id of a valid library section<br/> | 12 |

2
docs/models/operations/getsessionsmetadata.md
View File

@@ -39,6 +39,6 @@
| `updated_at` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1705543314 |
| `view_offset` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1000 |
| `media` | T::Array<[::OpenApiSDK::Operations::GetSessionsMedia](../../models/operations/getsessionsmedia.md)> | :heavy_minus_sign: | N/A | |
| `user` | [T.nilable(::OpenApiSDK::Operations::User)](../../models/operations/user.md) | :heavy_minus_sign: | N/A | |
| `user` | [T.nilable(::OpenApiSDK::Operations::GetSessionsUser)](../../models/operations/getsessionsuser.md) | :heavy_minus_sign: | N/A | |
| `player` | [T.nilable(::OpenApiSDK::Operations::Player)](../../models/operations/player.md) | :heavy_minus_sign: | N/A | |
| `session` | [T.nilable(::OpenApiSDK::Operations::Session)](../../models/operations/session.md) | :heavy_minus_sign: | N/A | |

10
docs/models/operations/getsessionsuser.md Normal file
View File

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

10
docs/models/operations/gettopwatchedcontentcountry.md Normal file
View File

@@ -0,0 +1,10 @@
# GetTopWatchedContentCountry
## Fields
| Field | Type | Required | Description | Example |
| ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ |
| `id` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 116 |
| `filter` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | country=116 |
| `tag` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | United States of America |

10
docs/models/operations/gettopwatchedcontentgenre.md Normal file
View File

@@ -0,0 +1,10 @@
# GetTopWatchedContentGenre
## Fields
| Field | Type | Required | Description | Example |
| ---------------------- | ---------------------- | ---------------------- | ---------------------- | ---------------------- |
| `id` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 184 |
| `filter` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | genre=184 |
| `tag` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Thriller |

8
docs/models/operations/gettopwatchedcontentguids.md Normal file
View File

@@ -0,0 +1,8 @@
# GetTopWatchedContentGuids
## Fields
| Field | Type | Required | Description | Example |
| --------------------- | --------------------- | --------------------- | --------------------- | --------------------- |
| `id` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | tvdb://2337 |

13
docs/models/operations/gettopwatchedcontentmediacontainer.md Normal file
View File

@@ -0,0 +1,13 @@
# GetTopWatchedContentMediaContainer
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
| `size` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1 |
| `allow_sync` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | true |
| `identifier` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
| `media_tag_prefix` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /system/bundle/media/flags/ |
| `media_tag_version` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1698860922 |
| `metadata` | T::Array<[::OpenApiSDK::Operations::GetTopWatchedContentMetadata](../../models/operations/gettopwatchedcontentmetadata.md)> | :heavy_minus_sign: | N/A | |

39
docs/models/operations/gettopwatchedcontentmetadata.md Normal file
View File

@@ -0,0 +1,39 @@
# GetTopWatchedContentMetadata
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `rating_key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 17 |
| `key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/17 |
| `guid` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | plex://movie/5d77683f6f4521001ea9dc53 |
| `slug` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | waterloo-road |
| `studio` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Universal Pictures |
| `type` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | movie |
| `title` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Serenity |
| `library_section_title` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Movies |
| `library_section_id` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1 |
| `library_section_key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/sections/1 |
| `content_rating` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | PG-13 |
| `summary` | *T.nilable(::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` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1 |
| `audience_rating` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 9.1 |
| `year` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 2005 |
| `tagline` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | They aim to misbehave. |
| `thumb` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/17/thumb/1705637165 |
| `art` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/17/art/1705637165 |
| `duration` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 141417 |
| `originally_available_at` | [DateTime](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/DateTime.html) | :heavy_minus_sign: | N/A | 2005-09-29 00:00:00 +0000 UTC |
| `leaf_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 222 |
| `viewed_leaf_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 100 |
| `child_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 13 |
| `added_at` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1705637164 |
| `updated_at` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1705637165 |
| `global_view_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 80 |
| `audience_rating_image` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright |
| `genre` | T::Array<[::OpenApiSDK::Operations::GetTopWatchedContentGenre](../../models/operations/gettopwatchedcontentgenre.md)> | :heavy_minus_sign: | N/A | |
| `country` | T::Array<[::OpenApiSDK::Operations::GetTopWatchedContentCountry](../../models/operations/gettopwatchedcontentcountry.md)> | :heavy_minus_sign: | N/A | |
| `guids` | T::Array<[::OpenApiSDK::Operations::GetTopWatchedContentGuids](../../models/operations/gettopwatchedcontentguids.md)> | :heavy_minus_sign: | N/A | |
| `role` | T::Array<[::OpenApiSDK::Operations::GetTopWatchedContentRole](../../models/operations/gettopwatchedcontentrole.md)> | :heavy_minus_sign: | N/A | |
| `user` | T::Array<[::OpenApiSDK::Operations::User](../../models/operations/user.md)> | :heavy_minus_sign: | N/A | |

9
docs/models/operations/gettopwatchedcontentrequest.md Normal file
View File

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

11
docs/models/operations/gettopwatchedcontentresponse.md Normal file
View File

@@ -0,0 +1,11 @@
# GetTopWatchedContentResponse
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ |
| `content_type` | *::String* | :heavy_check_mark: | HTTP response content type for this operation |
| `status_code` | *::Integer* | :heavy_check_mark: | HTTP response status code for this operation |
| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `object` | [T.nilable(::OpenApiSDK::Operations::GetTopWatchedContentResponseBody)](../../models/operations/gettopwatchedcontentresponsebody.md) | :heavy_minus_sign: | The metadata of the library item. |

10
docs/models/operations/gettopwatchedcontentresponsebody.md Normal file
View File

@@ -0,0 +1,10 @@
# GetTopWatchedContentResponseBody
The metadata of the library item.
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| `media_container` | [T.nilable(::OpenApiSDK::Operations::GetTopWatchedContentMediaContainer)](../../models/operations/gettopwatchedcontentmediacontainer.md) | :heavy_minus_sign: | N/A |

13
docs/models/operations/gettopwatchedcontentrole.md Normal file
View File

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

2
docs/models/operations/getwatchlistrequest.md
View File

@@ -5,7 +5,7 @@
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `filter` | [::OpenApiSDK::Operations::Filter](../../models/operations/filter.md) | :heavy_check_mark: | Filter |
| `filter` | [::OpenApiSDK::Operations::PathParamFilter](../../models/operations/pathparamfilter.md) | :heavy_check_mark: | Filter |
| `sort` | *T.nilable(::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` | [T.nilable(::OpenApiSDK::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` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of items to return. If not specified, all items will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/> |

12
docs/models/operations/pathparamfilter.md Normal file
View File

@@ -0,0 +1,12 @@
# PathParamFilter
Filter
## Values
| Name | Value |
| ----------- | ----------- |
| `ALL` | all |
| `AVAILABLE` | available |
| `RELEASED` | released |

13
docs/models/operations/statisticsbandwidth.md Normal file
View File

@@ -0,0 +1,13 @@
# StatisticsBandwidth
## Fields
| Field | Type | Required | Description | Example |
| ----------------------- | ----------------------- | ----------------------- | ----------------------- | ----------------------- |
| `account_id` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 238960586 |
| `device_id` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | |
| `timespan` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 6 |
| `at` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1718387650 |
| `lan` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | true |
| `bytes` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 22 |

13
docs/models/operations/statisticsresources.md Normal file
View File

@@ -0,0 +1,13 @@
# StatisticsResources
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- |
| `timespan` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 6 |
| `at` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1718384427 |
| `host_cpu_utilization` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 1.276 |
| `process_cpu_utilization` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 0.025 |
| `host_memory_utilization` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 17.026 |
| `process_memory_utilization` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 0.493 |

8
docs/models/operations/user.md
View File

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

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

@@ -18,6 +18,7 @@ API Calls interacting with Plex Media Server Libraries
* [search_library](#search_library) - Search Library
* [get_metadata](#get_metadata) - Get Items Metadata
* [get_metadata_children](#get_metadata_children) - Get Items Children
* [get_top_watched_content](#get_top_watched_content) - Get Top Watched Content
* [get_on_deck](#get_on_deck) - Get On Deck
## get_file_hash
@@ -296,7 +297,7 @@ s.config_security(
)
res = s.library.get_library_items(section_id="<value>", tag=::OpenApiSDK::Operations::Tag::GENRE)
res = s.library.get_library_items(section_id="<value>", tag=::OpenApiSDK::Operations::Tag::GENRE, include_guids=1)
if ! res.two_hundred_application_json_object.nil?
# handle response
@@ -306,10 +307,11 @@ end
### Parameters
| Parameter | Type | Required | Description |
| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- |
| `section_id` | *::Object* | :heavy_check_mark: | the Id of the library to query |
| `tag` | [::OpenApiSDK::Operations::Tag](../../models/operations/tag.md) | :heavy_check_mark: | A key representing a specific tag within the section. |
| Parameter | Type | Required | Description | Example |
| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- |
| `section_id` | *::Object* | :heavy_check_mark: | the Id of the library to query | |
| `tag` | [::OpenApiSDK::Operations::Tag](../../models/operations/tag.md) | :heavy_check_mark: | A key representing a specific tag within the section. | |
| `include_guids` | *::Integer* | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |
### Response
@@ -479,7 +481,7 @@ s.config_security(
)
res = s.library.get_metadata_children(rating_key=1539.14)
res = s.library.get_metadata_children(rating_key=1539.14, include_elements="<value>")
if ! res.two_hundred_application_json_object.nil?
# handle response
@@ -489,9 +491,10 @@ end
### Parameters
| Parameter | Type | Required | Description |
| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
| `rating_key` | *::Float* | :heavy_check_mark: | the id of the library item to return the children of. |
| Parameter | Type | Required | Description |
| ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- |
| `rating_key` | *::Float* | :heavy_check_mark: | the id of the library item to return the children of. |
| `include_elements` | *::String* | :heavy_minus_sign: | Adds additional elements to the response. Supported types are (Stream)<br/> |
### Response
@@ -499,6 +502,48 @@ end
**[T.nilable(::OpenApiSDK::Operations::GetMetadataChildrenResponse)](../../models/operations/getmetadatachildrenresponse.md)**
## get_top_watched_content
This endpoint will return the top watched content from libraries of a certain type
### Example Usage
```ruby
require 'plexruby'
s = ::OpenApiSDK::PlexAPI.new(
x_plex_client_identifier: "Postman",
)
s.config_security(
::OpenApiSDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
res = s.library.get_top_watched_content(type=505531, include_guids=1)
if ! res.object.nil?
# handle response
end
```
### Parameters
| Parameter | Type | Required | Description | Example |
| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- |
| `type` | *::Integer* | :heavy_check_mark: | the library type (1 - movies, 2 - shows, 3 - music) | |
| `include_guids` | *::Integer* | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |
### Response
**[T.nilable(::OpenApiSDK::Operations::GetTopWatchedContentResponse)](../../models/operations/gettopwatchedcontentresponse.md)**
## get_on_deck
This endpoint will return the on deck content.

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

@@ -8,7 +8,7 @@ Operations against the Plex Media Server System.
### Available Operations
* [get_server_capabilities](#get_server_capabilities) - Server Capabilities
* [get_server_capabilities](#get_server_capabilities) - Get Server Capabilities
* [get_server_preferences](#get_server_preferences) - Get Server Preferences
* [get_available_clients](#get_available_clients) - Get Available Clients
* [get_devices](#get_devices) - Get Devices
@@ -19,7 +19,7 @@ Operations against the Plex Media Server System.
## get_server_capabilities
Server Capabilities
Get Server Capabilities
### Example Usage

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

@@ -67,7 +67,7 @@ s.config_security(
)
res = s.sessions.get_session_history()
res = s.sessions.get_session_history(sort="<value>", account_id=1, filter=::OpenApiSDK::Operations::Filter.new(), library_section_id=12)
if ! res.two_hundred_application_json_object.nil?
# handle response
@@ -75,6 +75,15 @@ end
```
### Parameters
| Parameter | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `sort` | *::String* | :heavy_minus_sign: | Sorts the results by the specified field followed by the direction (asc, desc)<br/> | |
| `account_id` | *::Integer* | :heavy_minus_sign: | Filter results by those that are related to a specific users id<br/> | 1 |
| `filter` | [::OpenApiSDK::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/>} |
| `library_section_id` | *::Integer* | :heavy_minus_sign: | Filters the results based on the id of a valid library section<br/> | 12 |
### Response

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

@@ -9,6 +9,8 @@ API Calls that perform operations with Plex Media Server Statistics
### Available Operations
* [get_statistics](#get_statistics) - Get Media Statistics
* [get_resources_statistics](#get_resources_statistics) - Get Resources Statistics
* [get_bandwidth_statistics](#get_bandwidth_statistics) - Get Bandwidth Statistics
## get_statistics
@@ -49,3 +51,83 @@ end
**[T.nilable(::OpenApiSDK::Operations::GetStatisticsResponse)](../../models/operations/getstatisticsresponse.md)**
## get_resources_statistics
This will return the resources for the server
### Example Usage
```ruby
require 'plexruby'
s = ::OpenApiSDK::PlexAPI.new(
x_plex_client_identifier: "Postman",
)
s.config_security(
::OpenApiSDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
res = s.statistics.get_resources_statistics(timespan=4)
if ! res.two_hundred_application_json_object.nil?
# handle response
end
```
### Parameters
| Parameter | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| `timespan` | *::Integer* | :heavy_minus_sign: | The timespan to retrieve statistics for<br/>the exact meaning of this parameter is not known<br/> | 4 |
### Response
**[T.nilable(::OpenApiSDK::Operations::GetResourcesStatisticsResponse)](../../models/operations/getresourcesstatisticsresponse.md)**
## get_bandwidth_statistics
This will return the bandwidth statistics for the server
### Example Usage
```ruby
require 'plexruby'
s = ::OpenApiSDK::PlexAPI.new(
x_plex_client_identifier: "Postman",
)
s.config_security(
::OpenApiSDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
res = s.statistics.get_bandwidth_statistics(timespan=4)
if ! res.two_hundred_application_json_object.nil?
# handle response
end
```
### Parameters
| Parameter | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| `timespan` | *::Integer* | :heavy_minus_sign: | The timespan to retrieve statistics for<br/>the exact meaning of this parameter is not known<br/> | 4 |
### Response
**[T.nilable(::OpenApiSDK::Operations::GetBandwidthStatisticsResponse)](../../models/operations/getbandwidthstatisticsresponse.md)**

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

@@ -31,7 +31,7 @@ s.config_security(
req = ::OpenApiSDK::Operations::GetWatchlistRequest.new(
filter: ::OpenApiSDK::Operations::Filter::RELEASED,
filter: ::OpenApiSDK::Operations::PathParamFilter::RELEASED,
x_plex_token: "<value>",
)