mirror of
https://github.com/LukeHagar/plexruby.git
synced 2025-12-06 04:20:52 +00:00
ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.531.4
This commit is contained in:
speakeasybot
@@ -34,15 +34,15 @@ Create a new playlist. By default the playlist is blank. To create a playlist al
|
||||
require 'plex_ruby_sdk'
|
||||
|
||||
s = ::PlexRubySDK::PlexAPI.new(
|
||||
security: ::PlexRubySDK::Shared::Security.new(
|
||||
security: Models::Shared::Security.new(
|
||||
access_token: "<YOUR_API_KEY_HERE>",
|
||||
),
|
||||
)
|
||||
|
||||
req = ::PlexRubySDK::Operations::CreatePlaylistRequest.new(
|
||||
req = Models::Operations::CreatePlaylistRequest.new(
|
||||
title: "<value>",
|
||||
type: ::PlexRubySDK::Operations::CreatePlaylistQueryParamType::PHOTO,
|
||||
smart: ::PlexRubySDK::Operations::Smart::ONE,
|
||||
type: Models::Operations::CreatePlaylistQueryParamType::PHOTO,
|
||||
smart: Models::Operations::Smart::ONE,
|
||||
uri: "https://hoarse-testing.info/",
|
||||
)
|
||||
|
||||
@@ -56,13 +56,13 @@ end
|
||||
|
||||
### Parameters
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
|
||||
| `request` | [::PlexRubySDK::Operations::CreatePlaylistRequest](../../models/operations/createplaylistrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
||||
| `request` | [Models::Operations::CreatePlaylistRequest](../../models/operations/createplaylistrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
||||
|
||||
### Response
|
||||
|
||||
**[T.nilable(::PlexRubySDK::Operations::CreatePlaylistResponse)](../../models/operations/createplaylistresponse.md)**
|
||||
**[T.nilable(Models::Operations::CreatePlaylistResponse)](../../models/operations/createplaylistresponse.md)**
|
||||
|
||||
|
||||
|
||||
@@ -76,12 +76,12 @@ Get All Playlists given the specified filters.
|
||||
require 'plex_ruby_sdk'
|
||||
|
||||
s = ::PlexRubySDK::PlexAPI.new(
|
||||
security: ::PlexRubySDK::Shared::Security.new(
|
||||
security: Models::Shared::Security.new(
|
||||
access_token: "<YOUR_API_KEY_HERE>",
|
||||
),
|
||||
)
|
||||
|
||||
res = s.playlists.get_playlists(playlist_type=::PlexRubySDK::Operations::PlaylistType::AUDIO, smart=::PlexRubySDK::Operations::QueryParamSmart::ZERO)
|
||||
res = s.playlists.get_playlists(playlist_type=Models::Operations::PlaylistType::AUDIO, smart=Models::Operations::QueryParamSmart::ZERO)
|
||||
|
||||
if ! res.object.nil?
|
||||
# handle response
|
||||
@@ -91,14 +91,14 @@ end
|
||||
|
||||
### Parameters
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
|
||||
| `playlist_type` | [T.nilable(::PlexRubySDK::Operations::PlaylistType)](../../models/operations/playlisttype.md) | :heavy_minus_sign: | limit to a type of playlist. |
|
||||
| `smart` | [T.nilable(::PlexRubySDK::Operations::QueryParamSmart)](../../models/operations/queryparamsmart.md) | :heavy_minus_sign: | type of playlists to return (default is all). |
|
||||
| Parameter | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
|
||||
| `playlist_type` | [T.nilable(Models::Operations::PlaylistType)](../../models/operations/playlisttype.md) | :heavy_minus_sign: | limit to a type of playlist. |
|
||||
| `smart` | [T.nilable(Models::Operations::QueryParamSmart)](../../models/operations/queryparamsmart.md) | :heavy_minus_sign: | type of playlists to return (default is all). |
|
||||
|
||||
### Response
|
||||
|
||||
**[T.nilable(::PlexRubySDK::Operations::GetPlaylistsResponse)](../../models/operations/getplaylistsresponse.md)**
|
||||
**[T.nilable(Models::Operations::GetPlaylistsResponse)](../../models/operations/getplaylistsresponse.md)**
|
||||
|
||||
|
||||
|
||||
@@ -114,7 +114,7 @@ Smart playlist details contain the `content` attribute. This is the content URI
|
||||
require 'plex_ruby_sdk'
|
||||
|
||||
s = ::PlexRubySDK::PlexAPI.new(
|
||||
security: ::PlexRubySDK::Shared::Security.new(
|
||||
security: Models::Shared::Security.new(
|
||||
access_token: "<YOUR_API_KEY_HERE>",
|
||||
),
|
||||
)
|
||||
@@ -135,7 +135,7 @@ end
|
||||
|
||||
### Response
|
||||
|
||||
**[T.nilable(::PlexRubySDK::Operations::GetPlaylistResponse)](../../models/operations/getplaylistresponse.md)**
|
||||
**[T.nilable(Models::Operations::GetPlaylistResponse)](../../models/operations/getplaylistresponse.md)**
|
||||
|
||||
|
||||
|
||||
@@ -150,7 +150,7 @@ This endpoint will delete a playlist
|
||||
require 'plex_ruby_sdk'
|
||||
|
||||
s = ::PlexRubySDK::PlexAPI.new(
|
||||
security: ::PlexRubySDK::Shared::Security.new(
|
||||
security: Models::Shared::Security.new(
|
||||
access_token: "<YOUR_API_KEY_HERE>",
|
||||
),
|
||||
)
|
||||
@@ -171,7 +171,7 @@ end
|
||||
|
||||
### Response
|
||||
|
||||
**[T.nilable(::PlexRubySDK::Operations::DeletePlaylistResponse)](../../models/operations/deleteplaylistresponse.md)**
|
||||
**[T.nilable(Models::Operations::DeletePlaylistResponse)](../../models/operations/deleteplaylistresponse.md)**
|
||||
|
||||
|
||||
|
||||
@@ -186,7 +186,7 @@ From PMS version 1.9.1 clients can also edit playlist metadata using this endpoi
|
||||
require 'plex_ruby_sdk'
|
||||
|
||||
s = ::PlexRubySDK::PlexAPI.new(
|
||||
security: ::PlexRubySDK::Shared::Security.new(
|
||||
security: Models::Shared::Security.new(
|
||||
access_token: "<YOUR_API_KEY_HERE>",
|
||||
),
|
||||
)
|
||||
@@ -209,7 +209,7 @@ end
|
||||
|
||||
### Response
|
||||
|
||||
**[T.nilable(::PlexRubySDK::Operations::UpdatePlaylistResponse)](../../models/operations/updateplaylistresponse.md)**
|
||||
**[T.nilable(Models::Operations::UpdatePlaylistResponse)](../../models/operations/updateplaylistresponse.md)**
|
||||
|
||||
|
||||
|
||||
@@ -227,12 +227,12 @@ Note that for dumb playlists, items have a `playlistItemID` attribute which is u
|
||||
require 'plex_ruby_sdk'
|
||||
|
||||
s = ::PlexRubySDK::PlexAPI.new(
|
||||
security: ::PlexRubySDK::Shared::Security.new(
|
||||
security: Models::Shared::Security.new(
|
||||
access_token: "<YOUR_API_KEY_HERE>",
|
||||
),
|
||||
)
|
||||
|
||||
res = s.playlists.get_playlist_contents(playlist_id=5004.46, type=::PlexRubySDK::Operations::GetPlaylistContentsQueryParamType::TV_SHOW)
|
||||
res = s.playlists.get_playlist_contents(playlist_id=5004.46, type=Models::Operations::GetPlaylistContentsQueryParamType::TV_SHOW)
|
||||
|
||||
if ! res.object.nil?
|
||||
# handle response
|
||||
@@ -245,11 +245,11 @@ end
|
||||
| Parameter | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `playlist_id` | *::Float* | :heavy_check_mark: | the ID of the playlist | |
|
||||
| `type` | [::PlexRubySDK::Operations::GetPlaylistContentsQueryParamType](../../models/operations/getplaylistcontentsqueryparamtype.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
|
||||
| `type` | [Models::Operations::GetPlaylistContentsQueryParamType](../../models/operations/getplaylistcontentsqueryparamtype.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
|
||||
|
||||
### Response
|
||||
|
||||
**[T.nilable(::PlexRubySDK::Operations::GetPlaylistContentsResponse)](../../models/operations/getplaylistcontentsresponse.md)**
|
||||
**[T.nilable(Models::Operations::GetPlaylistContentsResponse)](../../models/operations/getplaylistcontentsresponse.md)**
|
||||
|
||||
|
||||
|
||||
@@ -264,7 +264,7 @@ Clears a playlist, only works with dumb playlists. Returns the playlist.
|
||||
require 'plex_ruby_sdk'
|
||||
|
||||
s = ::PlexRubySDK::PlexAPI.new(
|
||||
security: ::PlexRubySDK::Shared::Security.new(
|
||||
security: Models::Shared::Security.new(
|
||||
access_token: "<YOUR_API_KEY_HERE>",
|
||||
),
|
||||
)
|
||||
@@ -285,7 +285,7 @@ end
|
||||
|
||||
### Response
|
||||
|
||||
**[T.nilable(::PlexRubySDK::Operations::ClearPlaylistContentsResponse)](../../models/operations/clearplaylistcontentsresponse.md)**
|
||||
**[T.nilable(Models::Operations::ClearPlaylistContentsResponse)](../../models/operations/clearplaylistcontentsresponse.md)**
|
||||
|
||||
|
||||
|
||||
@@ -301,7 +301,7 @@ With a smart playlist, passing a new `uri` parameter replaces the rules for the
|
||||
require 'plex_ruby_sdk'
|
||||
|
||||
s = ::PlexRubySDK::PlexAPI.new(
|
||||
security: ::PlexRubySDK::Shared::Security.new(
|
||||
security: Models::Shared::Security.new(
|
||||
access_token: "<YOUR_API_KEY_HERE>",
|
||||
),
|
||||
)
|
||||
@@ -324,7 +324,7 @@ end
|
||||
|
||||
### Response
|
||||
|
||||
**[T.nilable(::PlexRubySDK::Operations::AddPlaylistContentsResponse)](../../models/operations/addplaylistcontentsresponse.md)**
|
||||
**[T.nilable(Models::Operations::AddPlaylistContentsResponse)](../../models/operations/addplaylistcontentsresponse.md)**
|
||||
|
||||
|
||||
|
||||
@@ -339,12 +339,12 @@ Imports m3u playlists by passing a path on the server to scan for m3u-formatted
|
||||
require 'plex_ruby_sdk'
|
||||
|
||||
s = ::PlexRubySDK::PlexAPI.new(
|
||||
security: ::PlexRubySDK::Shared::Security.new(
|
||||
security: Models::Shared::Security.new(
|
||||
access_token: "<YOUR_API_KEY_HERE>",
|
||||
),
|
||||
)
|
||||
|
||||
res = s.playlists.upload_playlist(path="/home/barkley/playlist.m3u", force=::PlexRubySDK::Operations::QueryParamForce::ZERO, section_id=1)
|
||||
res = s.playlists.upload_playlist(path="/home/barkley/playlist.m3u", force=Models::Operations::QueryParamForce::ZERO, section_id=1)
|
||||
|
||||
if res.status_code == 200
|
||||
# handle response
|
||||
@@ -357,10 +357,10 @@ end
|
||||
| Parameter | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `path` | *::String* | :heavy_check_mark: | absolute path to a directory on the server where m3u files are stored, or the absolute path to a playlist file on the server. <br/>If the `path` argument is a directory, that path will be scanned for playlist files to be processed. <br/>Each file in that directory creates a separate playlist, with a name based on the filename of the file that created it. <br/>The GUID of each playlist is based on the filename. <br/>If the `path` argument is a file, that file will be used to create a new playlist, with the name based on the filename of the file that created it. <br/>The GUID of each playlist is based on the filename.<br/> | /home/barkley/playlist.m3u |
|
||||
| `force` | [::PlexRubySDK::Operations::QueryParamForce](../../models/operations/queryparamforce.md) | :heavy_check_mark: | Force overwriting of duplicate playlists. <br/>By default, a playlist file uploaded with the same path will overwrite the existing playlist. <br/>The `force` argument is used to disable overwriting. <br/>If the `force` argument is set to 0, a new playlist will be created suffixed with the date and time that the duplicate was uploaded.<br/> | |
|
||||
| `force` | [Models::Operations::QueryParamForce](../../models/operations/queryparamforce.md) | :heavy_check_mark: | Force overwriting of duplicate playlists. <br/>By default, a playlist file uploaded with the same path will overwrite the existing playlist. <br/>The `force` argument is used to disable overwriting. <br/>If the `force` argument is set to 0, a new playlist will be created suffixed with the date and time that the duplicate was uploaded.<br/> | |
|
||||
| `section_id` | *::Integer* | :heavy_check_mark: | Possibly the section ID to upload the playlist to, we are not certain. | 1 |
|
||||
|
||||
### Response
|
||||
|
||||
**[T.nilable(::PlexRubySDK::Operations::UploadPlaylistResponse)](../../models/operations/uploadplaylistresponse.md)**
|
||||
**[T.nilable(Models::Operations::UploadPlaylistResponse)](../../models/operations/uploadplaylistresponse.md)**
|
||||
|
||||
|
||||
Reference in New Issue
Block a user