mirror of
https://github.com/LukeHagar/plexruby.git
synced 2025-12-07 04:20:54 +00:00
ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.531.4
This commit is contained in:
@@ -420,14 +420,14 @@ module PlexRubySDK
|
||||
# get_library_details - Get Library Details
|
||||
# ## Library Details Endpoint
|
||||
#
|
||||
# This endpoint provides comprehensive details about the library, focusing on organizational aspects rather than the content itself.
|
||||
# This endpoint provides comprehensive details about the library, focusing on organizational aspects rather than the content itself.
|
||||
#
|
||||
# The details include:
|
||||
#
|
||||
# ### Directories
|
||||
# Organized into three categories:
|
||||
#
|
||||
# - **Primary Directories**:
|
||||
# - **Primary Directories**:
|
||||
# - Used in some clients for quick access to media subsets (e.g., "All", "On Deck").
|
||||
# - Most can be replicated via media queries.
|
||||
# - Customizable by users.
|
||||
|
||||
@@ -155,13 +155,13 @@ module PlexRubySDK
|
||||
sig { params(request: ::String, timeout_ms: T.nilable(Integer)).returns(Models::Operations::LogMultiLineResponse) }
|
||||
def log_multi_line(request, timeout_ms = nil)
|
||||
# log_multi_line - Logging a multi-line message
|
||||
# This endpoint allows for the batch addition of log entries to the main Plex Media Server log.
|
||||
# It accepts a text/plain request body, where each line represents a distinct log entry.
|
||||
# Each log entry consists of URL-encoded key-value pairs, specifying log attributes such as 'level', 'message', and 'source'.
|
||||
# This endpoint allows for the batch addition of log entries to the main Plex Media Server log.
|
||||
# It accepts a text/plain request body, where each line represents a distinct log entry.
|
||||
# Each log entry consists of URL-encoded key-value pairs, specifying log attributes such as 'level', 'message', and 'source'.
|
||||
#
|
||||
# Log entries are separated by a newline character (`\n`).
|
||||
# Each entry's parameters should be URL-encoded to ensure accurate parsing and handling of special characters.
|
||||
# This method is efficient for logging multiple entries in a single API call, reducing the overhead of multiple individual requests.
|
||||
# Log entries are separated by a newline character (`\n`).
|
||||
# Each entry's parameters should be URL-encoded to ensure accurate parsing and handling of special characters.
|
||||
# This method is efficient for logging multiple entries in a single API call, reducing the overhead of multiple individual requests.
|
||||
#
|
||||
# The 'level' parameter specifies the log entry's severity or importance, with the following integer values:
|
||||
# - `0`: Error - Critical issues that require immediate attention.
|
||||
|
||||
@@ -17,7 +17,7 @@ module PlexRubySDK
|
||||
# Note: This is unique in the context of the Plex server.
|
||||
#
|
||||
field :section_key, ::Integer, { 'path_param': { 'field_name': 'sectionKey', 'style': 'simple', 'explode': false } }
|
||||
# Whether or not to include details for a section (types, filters, and sorts).
|
||||
# Whether or not to include details for a section (types, filters, and sorts).
|
||||
# Only exists for backwards compatibility, media providers other than the server libraries have it on always.
|
||||
#
|
||||
field :include_details, T.nilable(Models::Operations::IncludeDetails), { 'query_param': { 'field_name': 'includeDetails', 'style': 'form', 'explode': true } }
|
||||
|
||||
@@ -8,7 +8,7 @@ module PlexRubySDK
|
||||
module Models
|
||||
module Operations
|
||||
|
||||
# IncludeDetails - Whether or not to include details for a section (types, filters, and sorts).
|
||||
# IncludeDetails - Whether or not to include details for a section (types, filters, and sorts).
|
||||
# Only exists for backwards compatibility, media providers other than the server libraries have it on always.
|
||||
#
|
||||
class IncludeDetails < T::Enum
|
||||
|
||||
@@ -8,11 +8,11 @@ module PlexRubySDK
|
||||
module Models
|
||||
module Operations
|
||||
|
||||
# Level - An integer log level to write to the PMS log with.
|
||||
# 0: Error
|
||||
# 1: Warning
|
||||
# 2: Info
|
||||
# 3: Debug
|
||||
# Level - An integer log level to write to the PMS log with.
|
||||
# 0: Error
|
||||
# 1: Warning
|
||||
# 2: Info
|
||||
# 3: Debug
|
||||
# 4: Verbose
|
||||
#
|
||||
class Level < T::Enum
|
||||
|
||||
@@ -13,11 +13,11 @@ module PlexRubySDK
|
||||
extend T::Sig
|
||||
include Crystalline::MetadataFields
|
||||
|
||||
# An integer log level to write to the PMS log with.
|
||||
# 0: Error
|
||||
# 1: Warning
|
||||
# 2: Info
|
||||
# 3: Debug
|
||||
# An integer log level to write to the PMS log with.
|
||||
# 0: Error
|
||||
# 1: Warning
|
||||
# 2: Info
|
||||
# 3: Debug
|
||||
# 4: Verbose
|
||||
#
|
||||
field :level, Models::Operations::Level, { 'query_param': { 'field_name': 'level', 'style': 'form', 'explode': true } }
|
||||
|
||||
@@ -8,9 +8,9 @@ module PlexRubySDK
|
||||
module Models
|
||||
module Operations
|
||||
|
||||
# QueryParamForce - Force overwriting of duplicate playlists.
|
||||
# By default, a playlist file uploaded with the same path will overwrite the existing playlist.
|
||||
# The `force` argument is used to disable overwriting.
|
||||
# QueryParamForce - Force overwriting of duplicate playlists.
|
||||
# By default, a playlist file uploaded with the same path will overwrite the existing playlist.
|
||||
# The `force` argument is used to disable overwriting.
|
||||
# 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.
|
||||
#
|
||||
class QueryParamForce < T::Enum
|
||||
|
||||
@@ -13,17 +13,17 @@ module PlexRubySDK
|
||||
extend T::Sig
|
||||
include Crystalline::MetadataFields
|
||||
|
||||
# Force overwriting of duplicate playlists.
|
||||
# By default, a playlist file uploaded with the same path will overwrite the existing playlist.
|
||||
# The `force` argument is used to disable overwriting.
|
||||
# Force overwriting of duplicate playlists.
|
||||
# By default, a playlist file uploaded with the same path will overwrite the existing playlist.
|
||||
# The `force` argument is used to disable overwriting.
|
||||
# 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.
|
||||
#
|
||||
field :force, Models::Operations::QueryParamForce, { 'query_param': { 'field_name': 'force', 'style': 'form', 'explode': true } }
|
||||
# absolute path to a directory on the server where m3u files are stored, or the absolute path to a playlist file on the server.
|
||||
# If the `path` argument is a directory, that path will be scanned for playlist files to be processed.
|
||||
# Each file in that directory creates a separate playlist, with a name based on the filename of the file that created it.
|
||||
# The GUID of each playlist is based on the filename.
|
||||
# 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.
|
||||
# absolute path to a directory on the server where m3u files are stored, or the absolute path to a playlist file on the server.
|
||||
# If the `path` argument is a directory, that path will be scanned for playlist files to be processed.
|
||||
# Each file in that directory creates a separate playlist, with a name based on the filename of the file that created it.
|
||||
# The GUID of each playlist is based on the filename.
|
||||
# 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.
|
||||
# The GUID of each playlist is based on the filename.
|
||||
#
|
||||
field :path, ::String, { 'query_param': { 'field_name': 'path', 'style': 'form', 'explode': true } }
|
||||
|
||||
@@ -14,9 +14,9 @@ module PlexRubySDK
|
||||
extend T::Sig
|
||||
class Playlists
|
||||
extend T::Sig
|
||||
# Playlists are ordered collections of media. They can be dumb (just a list of media) or smart (based on a media query, such as "all albums from 2017").
|
||||
# Playlists are ordered collections of media. They can be dumb (just a list of media) or smart (based on a media query, such as "all albums from 2017").
|
||||
# They can be organized in (optionally nesting) folders.
|
||||
# Retrieving a playlist, or its items, will trigger a refresh of its metadata.
|
||||
# Retrieving a playlist, or its items, will trigger a refresh of its metadata.
|
||||
# This may cause the duration and number of items to change.
|
||||
#
|
||||
|
||||
|
||||
@@ -14,7 +14,7 @@ module PlexRubySDK
|
||||
extend T::Sig
|
||||
|
||||
SERVERS = [
|
||||
'{protocol}://{ip}:{port}', # 1 - The full address of your Plex Server
|
||||
'https://10.10.10.47:32400', # 1 - The full address of your Plex Server
|
||||
].freeze
|
||||
# Contains the list of servers available to the SDK
|
||||
|
||||
@@ -66,9 +66,9 @@ module PlexRubySDK
|
||||
end
|
||||
@language = 'ruby'
|
||||
@openapi_doc_version = '0.0.3'
|
||||
@sdk_version = '0.10.0'
|
||||
@sdk_version = '0.11.1'
|
||||
@gen_version = '2.570.4'
|
||||
@user_agent = 'speakeasy-sdk/ruby 0.10.0 2.570.4 0.0.3 plex_ruby_sdk'
|
||||
@user_agent = 'speakeasy-sdk/ruby 0.11.1 2.570.4 0.0.3 plex_ruby_sdk'
|
||||
end
|
||||
|
||||
sig { returns([String, T::Hash[Symbol, String]]) }
|
||||
|
||||
Reference in New Issue
Block a user