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

ci: regenerated with OpenAPI Doc 0.0.3, Speakeasy CLI 1.133.1

Browse Source
This commit is contained in:
speakeasybot
2024-01-07 00:54:49 +00:00
parent 658f41b15a
commit f8c0df2c69
427 changed files with 206307 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

144
docs/sdks/media/README.md Normal file
View File

@@ -0,0 +1,144 @@
# Media
## Overview
API Calls interacting with Plex Media Server Media
### Available Operations
* [mark_played](#mark_played) - Mark Media Played
* [mark_unplayed](#mark_unplayed) - Mark Media Unplayed
* [update_play_progress](#update_play_progress) - Update Media Play Progress
## mark_played
This will mark the provided media key as Played.
### Example Usage
```ruby
require_relative plexruby
s = OpenApiSDK::PlexAPI.new
s.config_security(
security=Shared::Security.new(
access_token="<YOUR_API_KEY_HERE>",
)
)
req = Operations::MarkPlayedRequest.new(
key=59398,
)
res = s.media.mark_played(key=59398)
if res.status == 200
# handle response
end
```
### Parameters
| Parameter | Type | Required | Description | Example |
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
| `key` | *Float* | :heavy_check_mark: | The media key to mark as played | 59398 |
### Response
**[T.nilable(Operations::MarkPlayedResponse)](../../models/operations/markplayedresponse.md)**
## mark_unplayed
This will mark the provided media key as Unplayed.
### Example Usage
```ruby
require_relative plexruby
s = OpenApiSDK::PlexAPI.new
s.config_security(
security=Shared::Security.new(
access_token="<YOUR_API_KEY_HERE>",
)
)
req = Operations::MarkUnplayedRequest.new(
key=59398,
)
res = s.media.mark_unplayed(key=59398)
if res.status == 200
# handle response
end
```
### Parameters
| Parameter | Type | Required | Description | Example |
| --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- |
| `key` | *Float* | :heavy_check_mark: | The media key to mark as Unplayed | 59398 |
### Response
**[T.nilable(Operations::MarkUnplayedResponse)](../../models/operations/markunplayedresponse.md)**
## update_play_progress
This API command can be used to update the play progress of a media item.
### Example Usage
```ruby
require_relative plexruby
s = OpenApiSDK::PlexAPI.new
s.config_security(
security=Shared::Security.new(
access_token="<YOUR_API_KEY_HERE>",
)
)
req = Operations::UpdatePlayProgressRequest.new(
key="<key>",
time=6900.91,
state="string",
)
res = s.media.update_play_progress(key="string", time=8015.87, state="string")
if res.status == 200
# handle response
end
```
### Parameters
| Parameter | Type | Required | Description |
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
| `key` | *String* | :heavy_check_mark: | the media key |
| `time` | *Float* | :heavy_check_mark: | The time, in milliseconds, used to set the media playback progress. |
| `state` | *String* | :heavy_check_mark: | The playback state of the media item. |
### Response
**[T.nilable(Operations::UpdatePlayProgressResponse)](../../models/operations/updateplayprogressresponse.md)**