LukeParke/plexruby
1
0
Fork 0
mirror of https://github.com/LukeHagar/plexruby.git synced 2025-12-10 04:21:03 +00:00
Code Issues Packages Projects Releases Wiki Activity

regenerated with newest spec, reconfigured actions and adding publishing

Browse Source
This commit is contained in:
Luke Hagar
2024-09-16 15:42:38 +00:00
parent fa4cfa3643
commit b689f4fe66
1660 changed files with 29288 additions and 15630 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -1,6 +1,5 @@
# Watchlist
## Overview
API Calls that perform operations with Plex Media Server Watchlists
@@ -8,9 +7,9 @@ API Calls that perform operations with Plex Media Server Watchlists
### Available Operations
* [get_watchlist](#get_watchlist) - Get User Watchlist
* [get_watch_list](#get_watch_list) - Get User Watchlist
## get_watchlist
## get_watch_list
Get User Watchlist
@@ -20,24 +19,26 @@ Get User Watchlist
require 'plexruby'
s = ::OpenApiSDK::PlexAPI.new(
x_plex_client_identifier: "Postman",
s = ::PlexRubySDK::PlexAPI.new(
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
)
s.config_security(
::OpenApiSDK::Shared::Security.new(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
req = ::OpenApiSDK::Operations::GetWatchlistRequest.new(
filter: ::OpenApiSDK::Operations::PathParamFilter::RELEASED,
x_plex_token: "<value>",
req = ::PlexRubySDK::Operations::GetWatchListRequest.new(
filter: ::PlexRubySDK::Operations::Filter::AVAILABLE,
x_plex_container_start: 0,
x_plex_container_size: 50,
x_plex_token: "CV5xoxjTpFKUzBTShsaf",
)
res = s.watchlist.get_watchlist(req)
res = s.watchlist.get_watch_list(req)
if ! res.two_hundred_application_json_object.nil?
if ! res.object.nil?
# handle response
end
@@ -45,13 +46,13 @@ end
### Parameters
| Parameter | Type | Required | Description |
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
| `request` | [::OpenApiSDK::Operations::GetWatchlistRequest](../../models/operations/getwatchlistrequest.md) | :heavy_check_mark: | The request object to use for the request. |
| `server_url` | *String* | :heavy_minus_sign: | An optional server URL to use. |
| Parameter | Type | Required | Description |
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
| `request` | [::PlexRubySDK::Operations::GetWatchListRequest](../../models/operations/getwatchlistrequest.md) | :heavy_check_mark: | The request object to use for the request. |
| `server_url` | *String* | :heavy_minus_sign: | An optional server URL to use. |
### Response
**[T.nilable(::OpenApiSDK::Operations::GetWatchlistResponse)](../../models/operations/getwatchlistresponse.md)**
**[T.nilable(::PlexRubySDK::Operations::GetWatchListResponse)](../../models/operations/getwatchlistresponse.md)**