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

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>",
)