From 9ccab7b22d4d79a6c691d9f33e01b37238c850a5 Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Sat, 19 Apr 2025 00:24:30 +0000 Subject: [PATCH] ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.529.1 --- .speakeasy/gen.lock | 6 ++--- .speakeasy/gen.yaml | 2 +- .speakeasy/workflow.lock | 12 +++++----- LukeHagar/PlexAPI/SDK/Activities.cs | 4 ++-- LukeHagar/PlexAPI/SDK/Authentication.cs | 4 ++-- LukeHagar/PlexAPI/SDK/Butler.cs | 4 ++-- LukeHagar/PlexAPI/SDK/Hubs.cs | 4 ++-- LukeHagar/PlexAPI/SDK/Library.cs | 8 +++---- LukeHagar/PlexAPI/SDK/Log.cs | 16 +++++++------- .../PlexAPI/SDK/LukeHagar.PlexAPI.SDK.csproj | 2 +- LukeHagar/PlexAPI/SDK/Media.cs | 4 ++-- .../Requests/GetLibraryDetailsRequest.cs | 2 +- .../SDK/Models/Requests/IncludeDetails.cs | 2 +- .../PlexAPI/SDK/Models/Requests/Level.cs | 10 ++++----- .../SDK/Models/Requests/LogLineRequest.cs | 10 ++++----- .../SDK/Models/Requests/QueryParamForce.cs | 6 ++--- .../Models/Requests/UploadPlaylistRequest.cs | 16 +++++++------- LukeHagar/PlexAPI/SDK/Playlists.cs | 12 +++++----- LukeHagar/PlexAPI/SDK/Plex.cs | 4 ++-- LukeHagar/PlexAPI/SDK/PlexAPI.cs | 10 ++++----- LukeHagar/PlexAPI/SDK/Search.cs | 4 ++-- LukeHagar/PlexAPI/SDK/Server.cs | 4 ++-- LukeHagar/PlexAPI/SDK/Sessions.cs | 4 ++-- LukeHagar/PlexAPI/SDK/Statistics.cs | 4 ++-- LukeHagar/PlexAPI/SDK/Updater.cs | 4 ++-- LukeHagar/PlexAPI/SDK/Users.cs | 4 ++-- LukeHagar/PlexAPI/SDK/Video.cs | 4 ++-- LukeHagar/PlexAPI/SDK/Watchlist.cs | 4 ++-- RELEASES.md | 12 +++++++++- .../Requests/GetLibraryDetailsRequest.md | 8 +++---- docs/Models/Requests/IncludeDetails.md | 2 +- docs/Models/Requests/Level.md | 10 ++++----- docs/Models/Requests/LogLineRequest.md | 10 ++++----- docs/Models/Requests/QueryParamForce.md | 6 ++--- docs/Models/Requests/UploadPlaylistRequest.md | 10 ++++----- docs/sdks/library/README.md | 12 +++++----- docs/sdks/log/README.md | 22 +++++++++---------- docs/sdks/playlists/README.md | 14 ++++++------ 38 files changed, 143 insertions(+), 133 deletions(-) diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock index 7224244..13da95b 100755 --- a/.speakeasy/gen.lock +++ b/.speakeasy/gen.lock @@ -1,12 +1,12 @@ lockVersion: 2.0.0 id: 5a8dbcbc-e0ee-41f0-9d84-b8b50567d1e9 management: - docChecksum: fa4c9c5c23680ad02fdbe831ad9d2403 + docChecksum: 89dadbc8c2d01913eaf905dadd40f814 docVersion: 0.0.3 speakeasyVersion: 1.529.1 generationVersion: 2.566.5 - releaseVersion: 0.14.7 - configChecksum: 1243b9da6434208f9da659b9ee396e1e + releaseVersion: 0.14.9 + configChecksum: 02a854ef749cc9aa0ca3d2bc8effe58a repoURL: https://github.com/LukeHagar/plexcsharp.git repoSubDirectory: . published: true diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml index 946e937..ebdfb58 100644 --- a/.speakeasy/gen.yaml +++ b/.speakeasy/gen.yaml @@ -15,7 +15,7 @@ generation: oAuth2ClientCredentialsEnabled: true oAuth2PasswordEnabled: false csharp: - version: 0.14.7 + version: 0.14.9 additionalDependencies: [] author: LukeHagar clientServerStatusCodesAsErrors: true diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock index 1cd476a..4eb64ab 100644 --- a/.speakeasy/workflow.lock +++ b/.speakeasy/workflow.lock @@ -16,19 +16,19 @@ sources: - main plexapi: sourceNamespace: plexapi - sourceRevisionDigest: sha256:db75a06885b897418dcb580679b5f744348573ad317155172346d32442420e5e - sourceBlobDigest: sha256:ac0a3c3a6df002378b3522325c2330ba4309fbbbfa503a04b8267398f20033f5 + sourceRevisionDigest: sha256:b2f9599237ceb13cf8f9c1693e38b290177b65fb389cebf0c3c60b8ef4778615 + sourceBlobDigest: sha256:f8df9ef88ada992cd981d601e6c0b45cc82db76aba3d915c2f9d08f90c81ced9 tags: - latest - - speakeasy-sdk-regen-1744590298 + - speakeasy-sdk-regen-1745022139 targets: plexcsharp: source: plexapi sourceNamespace: plexapi - sourceRevisionDigest: sha256:db75a06885b897418dcb580679b5f744348573ad317155172346d32442420e5e - sourceBlobDigest: sha256:ac0a3c3a6df002378b3522325c2330ba4309fbbbfa503a04b8267398f20033f5 + sourceRevisionDigest: sha256:b2f9599237ceb13cf8f9c1693e38b290177b65fb389cebf0c3c60b8ef4778615 + sourceBlobDigest: sha256:f8df9ef88ada992cd981d601e6c0b45cc82db76aba3d915c2f9d08f90c81ced9 codeSamplesNamespace: code-samples-csharp-plexcsharp - codeSamplesRevisionDigest: sha256:ec883fa872bc8d5a07af0721db6cb462697db4d0edb92845591f29b775aa3c46 + codeSamplesRevisionDigest: sha256:004ab610284c105c8117c397a7f5978e24de0ef188017a338cb854644394a990 workflow: workflowVersion: 1.0.0 speakeasyVersion: latest diff --git a/LukeHagar/PlexAPI/SDK/Activities.cs b/LukeHagar/PlexAPI/SDK/Activities.cs index a11e1c2..0412a03 100644 --- a/LukeHagar/PlexAPI/SDK/Activities.cs +++ b/LukeHagar/PlexAPI/SDK/Activities.cs @@ -74,10 +74,10 @@ namespace LukeHagar.PlexAPI.SDK { public SDKConfig SDKConfiguration { get; private set; } private const string _language = "csharp"; - private const string _sdkVersion = "0.14.7"; + private const string _sdkVersion = "0.14.9"; private const string _sdkGenVersion = "2.566.5"; private const string _openapiDocVersion = "0.0.3"; - private const string _userAgent = "speakeasy-sdk/csharp 0.14.7 2.566.5 0.0.3 LukeHagar.PlexAPI.SDK"; + private const string _userAgent = "speakeasy-sdk/csharp 0.14.9 2.566.5 0.0.3 LukeHagar.PlexAPI.SDK"; private string _serverUrl = ""; private ISpeakeasyHttpClient _client; private Func? _securitySource; diff --git a/LukeHagar/PlexAPI/SDK/Authentication.cs b/LukeHagar/PlexAPI/SDK/Authentication.cs index 66b297a..3dfba54 100644 --- a/LukeHagar/PlexAPI/SDK/Authentication.cs +++ b/LukeHagar/PlexAPI/SDK/Authentication.cs @@ -95,10 +95,10 @@ namespace LukeHagar.PlexAPI.SDK }; public SDKConfig SDKConfiguration { get; private set; } private const string _language = "csharp"; - private const string _sdkVersion = "0.14.7"; + private const string _sdkVersion = "0.14.9"; private const string _sdkGenVersion = "2.566.5"; private const string _openapiDocVersion = "0.0.3"; - private const string _userAgent = "speakeasy-sdk/csharp 0.14.7 2.566.5 0.0.3 LukeHagar.PlexAPI.SDK"; + private const string _userAgent = "speakeasy-sdk/csharp 0.14.9 2.566.5 0.0.3 LukeHagar.PlexAPI.SDK"; private string _serverUrl = ""; private ISpeakeasyHttpClient _client; private Func? _securitySource; diff --git a/LukeHagar/PlexAPI/SDK/Butler.cs b/LukeHagar/PlexAPI/SDK/Butler.cs index 94856a9..1b22afc 100644 --- a/LukeHagar/PlexAPI/SDK/Butler.cs +++ b/LukeHagar/PlexAPI/SDK/Butler.cs @@ -101,10 +101,10 @@ namespace LukeHagar.PlexAPI.SDK { public SDKConfig SDKConfiguration { get; private set; } private const string _language = "csharp"; - private const string _sdkVersion = "0.14.7"; + private const string _sdkVersion = "0.14.9"; private const string _sdkGenVersion = "2.566.5"; private const string _openapiDocVersion = "0.0.3"; - private const string _userAgent = "speakeasy-sdk/csharp 0.14.7 2.566.5 0.0.3 LukeHagar.PlexAPI.SDK"; + private const string _userAgent = "speakeasy-sdk/csharp 0.14.9 2.566.5 0.0.3 LukeHagar.PlexAPI.SDK"; private string _serverUrl = ""; private ISpeakeasyHttpClient _client; private Func? _securitySource; diff --git a/LukeHagar/PlexAPI/SDK/Hubs.cs b/LukeHagar/PlexAPI/SDK/Hubs.cs index a37ded8..21a1118 100644 --- a/LukeHagar/PlexAPI/SDK/Hubs.cs +++ b/LukeHagar/PlexAPI/SDK/Hubs.cs @@ -73,10 +73,10 @@ namespace LukeHagar.PlexAPI.SDK { public SDKConfig SDKConfiguration { get; private set; } private const string _language = "csharp"; - private const string _sdkVersion = "0.14.7"; + private const string _sdkVersion = "0.14.9"; private const string _sdkGenVersion = "2.566.5"; private const string _openapiDocVersion = "0.0.3"; - private const string _userAgent = "speakeasy-sdk/csharp 0.14.7 2.566.5 0.0.3 LukeHagar.PlexAPI.SDK"; + private const string _userAgent = "speakeasy-sdk/csharp 0.14.9 2.566.5 0.0.3 LukeHagar.PlexAPI.SDK"; private string _serverUrl = ""; private ISpeakeasyHttpClient _client; private Func? _securitySource; diff --git a/LukeHagar/PlexAPI/SDK/Library.cs b/LukeHagar/PlexAPI/SDK/Library.cs index 633f7c7..fb319bf 100644 --- a/LukeHagar/PlexAPI/SDK/Library.cs +++ b/LukeHagar/PlexAPI/SDK/Library.cs @@ -72,14 +72,14 @@ namespace LukeHagar.PlexAPI.SDK /// /// ## 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.
@@ -318,10 +318,10 @@ namespace LukeHagar.PlexAPI.SDK { public SDKConfig SDKConfiguration { get; private set; } private const string _language = "csharp"; - private const string _sdkVersion = "0.14.7"; + private const string _sdkVersion = "0.14.9"; private const string _sdkGenVersion = "2.566.5"; private const string _openapiDocVersion = "0.0.3"; - private const string _userAgent = "speakeasy-sdk/csharp 0.14.7 2.566.5 0.0.3 LukeHagar.PlexAPI.SDK"; + private const string _userAgent = "speakeasy-sdk/csharp 0.14.9 2.566.5 0.0.3 LukeHagar.PlexAPI.SDK"; private string _serverUrl = ""; private ISpeakeasyHttpClient _client; private Func? _securitySource; diff --git a/LukeHagar/PlexAPI/SDK/Log.cs b/LukeHagar/PlexAPI/SDK/Log.cs index 459dfd0..062f7bb 100644 --- a/LukeHagar/PlexAPI/SDK/Log.cs +++ b/LukeHagar/PlexAPI/SDK/Log.cs @@ -46,13 +46,13 @@ namespace LukeHagar.PlexAPI.SDK /// 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.
@@ -94,10 +94,10 @@ namespace LukeHagar.PlexAPI.SDK { public SDKConfig SDKConfiguration { get; private set; } private const string _language = "csharp"; - private const string _sdkVersion = "0.14.7"; + private const string _sdkVersion = "0.14.9"; private const string _sdkGenVersion = "2.566.5"; private const string _openapiDocVersion = "0.0.3"; - private const string _userAgent = "speakeasy-sdk/csharp 0.14.7 2.566.5 0.0.3 LukeHagar.PlexAPI.SDK"; + private const string _userAgent = "speakeasy-sdk/csharp 0.14.9 2.566.5 0.0.3 LukeHagar.PlexAPI.SDK"; private string _serverUrl = ""; private ISpeakeasyHttpClient _client; private Func? _securitySource; diff --git a/LukeHagar/PlexAPI/SDK/LukeHagar.PlexAPI.SDK.csproj b/LukeHagar/PlexAPI/SDK/LukeHagar.PlexAPI.SDK.csproj index 5f18879..b13df9e 100644 --- a/LukeHagar/PlexAPI/SDK/LukeHagar.PlexAPI.SDK.csproj +++ b/LukeHagar/PlexAPI/SDK/LukeHagar.PlexAPI.SDK.csproj @@ -3,7 +3,7 @@ true LukeHagar.PlexAPI.SDK - 0.14.7 + 0.14.9 net8.0 LukeHagar Copyright (c) LukeHagar 2025 diff --git a/LukeHagar/PlexAPI/SDK/Media.cs b/LukeHagar/PlexAPI/SDK/Media.cs index 5789229..a50a317 100644 --- a/LukeHagar/PlexAPI/SDK/Media.cs +++ b/LukeHagar/PlexAPI/SDK/Media.cs @@ -90,10 +90,10 @@ namespace LukeHagar.PlexAPI.SDK { public SDKConfig SDKConfiguration { get; private set; } private const string _language = "csharp"; - private const string _sdkVersion = "0.14.7"; + private const string _sdkVersion = "0.14.9"; private const string _sdkGenVersion = "2.566.5"; private const string _openapiDocVersion = "0.0.3"; - private const string _userAgent = "speakeasy-sdk/csharp 0.14.7 2.566.5 0.0.3 LukeHagar.PlexAPI.SDK"; + private const string _userAgent = "speakeasy-sdk/csharp 0.14.9 2.566.5 0.0.3 LukeHagar.PlexAPI.SDK"; private string _serverUrl = ""; private ISpeakeasyHttpClient _client; private Func? _securitySource; diff --git a/LukeHagar/PlexAPI/SDK/Models/Requests/GetLibraryDetailsRequest.cs b/LukeHagar/PlexAPI/SDK/Models/Requests/GetLibraryDetailsRequest.cs index b093ea8..3f78827 100644 --- a/LukeHagar/PlexAPI/SDK/Models/Requests/GetLibraryDetailsRequest.cs +++ b/LukeHagar/PlexAPI/SDK/Models/Requests/GetLibraryDetailsRequest.cs @@ -16,7 +16,7 @@ namespace LukeHagar.PlexAPI.SDK.Models.Requests { /// - /// 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.
diff --git a/LukeHagar/PlexAPI/SDK/Models/Requests/IncludeDetails.cs b/LukeHagar/PlexAPI/SDK/Models/Requests/IncludeDetails.cs index 428f4b6..9b9bae4 100644 --- a/LukeHagar/PlexAPI/SDK/Models/Requests/IncludeDetails.cs +++ b/LukeHagar/PlexAPI/SDK/Models/Requests/IncludeDetails.cs @@ -12,7 +12,7 @@ namespace LukeHagar.PlexAPI.SDK.Models.Requests using LukeHagar.PlexAPI.SDK.Utils; /// - /// 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.
diff --git a/LukeHagar/PlexAPI/SDK/Models/Requests/Level.cs b/LukeHagar/PlexAPI/SDK/Models/Requests/Level.cs index 89f6224..df8ebd7 100644 --- a/LukeHagar/PlexAPI/SDK/Models/Requests/Level.cs +++ b/LukeHagar/PlexAPI/SDK/Models/Requests/Level.cs @@ -12,13 +12,13 @@ namespace LukeHagar.PlexAPI.SDK.Models.Requests using LukeHagar.PlexAPI.SDK.Utils; /// - /// An integer log level to write to the PMS log with.
+ /// An integer log level to write to the PMS log with.
/// /// - /// 0: Error
- /// 1: Warning
- /// 2: Info
- /// 3: Debug
+ /// 0: Error
+ /// 1: Warning
+ /// 2: Info
+ /// 3: Debug
/// 4: Verbose
/// /// diff --git a/LukeHagar/PlexAPI/SDK/Models/Requests/LogLineRequest.cs b/LukeHagar/PlexAPI/SDK/Models/Requests/LogLineRequest.cs index 4660be8..345d519 100644 --- a/LukeHagar/PlexAPI/SDK/Models/Requests/LogLineRequest.cs +++ b/LukeHagar/PlexAPI/SDK/Models/Requests/LogLineRequest.cs @@ -16,13 +16,13 @@ namespace LukeHagar.PlexAPI.SDK.Models.Requests { /// - /// An integer log level to write to the PMS log with.
+ /// An integer log level to write to the PMS log with.
/// /// - /// 0: Error
- /// 1: Warning
- /// 2: Info
- /// 3: Debug
+ /// 0: Error
+ /// 1: Warning
+ /// 2: Info
+ /// 3: Debug
/// 4: Verbose
/// /// diff --git a/LukeHagar/PlexAPI/SDK/Models/Requests/QueryParamForce.cs b/LukeHagar/PlexAPI/SDK/Models/Requests/QueryParamForce.cs index 108c9be..debe76d 100644 --- a/LukeHagar/PlexAPI/SDK/Models/Requests/QueryParamForce.cs +++ b/LukeHagar/PlexAPI/SDK/Models/Requests/QueryParamForce.cs @@ -12,11 +12,11 @@ namespace LukeHagar.PlexAPI.SDK.Models.Requests using LukeHagar.PlexAPI.SDK.Utils; /// - /// Force overwriting of duplicate playlists.
+ /// 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.
+ /// 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.
/// /// diff --git a/LukeHagar/PlexAPI/SDK/Models/Requests/UploadPlaylistRequest.cs b/LukeHagar/PlexAPI/SDK/Models/Requests/UploadPlaylistRequest.cs index 3bcfe37..c6ca5c7 100644 --- a/LukeHagar/PlexAPI/SDK/Models/Requests/UploadPlaylistRequest.cs +++ b/LukeHagar/PlexAPI/SDK/Models/Requests/UploadPlaylistRequest.cs @@ -16,13 +16,13 @@ namespace LukeHagar.PlexAPI.SDK.Models.Requests { /// - /// absolute path to a directory on the server where m3u files are stored, or the absolute path to a playlist file on the server.
+ /// 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.
+ /// 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.
/// /// @@ -31,11 +31,11 @@ namespace LukeHagar.PlexAPI.SDK.Models.Requests public string Path { get; set; } = default!; /// - /// Force overwriting of duplicate playlists.
+ /// 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.
+ /// 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.
/// /// diff --git a/LukeHagar/PlexAPI/SDK/Playlists.cs b/LukeHagar/PlexAPI/SDK/Playlists.cs index 30eab81..4ddbb2f 100644 --- a/LukeHagar/PlexAPI/SDK/Playlists.cs +++ b/LukeHagar/PlexAPI/SDK/Playlists.cs @@ -23,11 +23,11 @@ namespace LukeHagar.PlexAPI.SDK using System.Threading.Tasks; /// - /// 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.
/// /// @@ -133,11 +133,11 @@ namespace LukeHagar.PlexAPI.SDK } /// - /// 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.
/// /// @@ -146,10 +146,10 @@ namespace LukeHagar.PlexAPI.SDK { public SDKConfig SDKConfiguration { get; private set; } private const string _language = "csharp"; - private const string _sdkVersion = "0.14.7"; + private const string _sdkVersion = "0.14.9"; private const string _sdkGenVersion = "2.566.5"; private const string _openapiDocVersion = "0.0.3"; - private const string _userAgent = "speakeasy-sdk/csharp 0.14.7 2.566.5 0.0.3 LukeHagar.PlexAPI.SDK"; + private const string _userAgent = "speakeasy-sdk/csharp 0.14.9 2.566.5 0.0.3 LukeHagar.PlexAPI.SDK"; private string _serverUrl = ""; private ISpeakeasyHttpClient _client; private Func? _securitySource; diff --git a/LukeHagar/PlexAPI/SDK/Plex.cs b/LukeHagar/PlexAPI/SDK/Plex.cs index 8c354f5..bc95341 100644 --- a/LukeHagar/PlexAPI/SDK/Plex.cs +++ b/LukeHagar/PlexAPI/SDK/Plex.cs @@ -143,10 +143,10 @@ namespace LukeHagar.PlexAPI.SDK }; public SDKConfig SDKConfiguration { get; private set; } private const string _language = "csharp"; - private const string _sdkVersion = "0.14.7"; + private const string _sdkVersion = "0.14.9"; private const string _sdkGenVersion = "2.566.5"; private const string _openapiDocVersion = "0.0.3"; - private const string _userAgent = "speakeasy-sdk/csharp 0.14.7 2.566.5 0.0.3 LukeHagar.PlexAPI.SDK"; + private const string _userAgent = "speakeasy-sdk/csharp 0.14.9 2.566.5 0.0.3 LukeHagar.PlexAPI.SDK"; private string _serverUrl = ""; private ISpeakeasyHttpClient _client; private Func? _securitySource; diff --git a/LukeHagar/PlexAPI/SDK/PlexAPI.cs b/LukeHagar/PlexAPI/SDK/PlexAPI.cs index 8d9eb2e..8f04145 100644 --- a/LukeHagar/PlexAPI/SDK/PlexAPI.cs +++ b/LukeHagar/PlexAPI/SDK/PlexAPI.cs @@ -205,11 +205,11 @@ namespace LukeHagar.PlexAPI.SDK public ILog Log { get; } /// - /// 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.
/// /// @@ -261,7 +261,7 @@ namespace LukeHagar.PlexAPI.SDK /// List of server URLs available to the SDK. /// public static readonly string[] ServerList = { - "https://10.10.10.47:32400", + "{protocol}://{ip}:{port}", }; public string ServerUrl = ""; @@ -327,10 +327,10 @@ namespace LukeHagar.PlexAPI.SDK public SDKConfig SDKConfiguration { get; private set; } private const string _language = "csharp"; - private const string _sdkVersion = "0.14.7"; + private const string _sdkVersion = "0.14.9"; private const string _sdkGenVersion = "2.566.5"; private const string _openapiDocVersion = "0.0.3"; - private const string _userAgent = "speakeasy-sdk/csharp 0.14.7 2.566.5 0.0.3 LukeHagar.PlexAPI.SDK"; + private const string _userAgent = "speakeasy-sdk/csharp 0.14.9 2.566.5 0.0.3 LukeHagar.PlexAPI.SDK"; private string _serverUrl = ""; private int _serverIndex = 0; private ISpeakeasyHttpClient _client; diff --git a/LukeHagar/PlexAPI/SDK/Search.cs b/LukeHagar/PlexAPI/SDK/Search.cs index 08af6a4..547aa1b 100644 --- a/LukeHagar/PlexAPI/SDK/Search.cs +++ b/LukeHagar/PlexAPI/SDK/Search.cs @@ -87,10 +87,10 @@ namespace LukeHagar.PlexAPI.SDK { public SDKConfig SDKConfiguration { get; private set; } private const string _language = "csharp"; - private const string _sdkVersion = "0.14.7"; + private const string _sdkVersion = "0.14.9"; private const string _sdkGenVersion = "2.566.5"; private const string _openapiDocVersion = "0.0.3"; - private const string _userAgent = "speakeasy-sdk/csharp 0.14.7 2.566.5 0.0.3 LukeHagar.PlexAPI.SDK"; + private const string _userAgent = "speakeasy-sdk/csharp 0.14.9 2.566.5 0.0.3 LukeHagar.PlexAPI.SDK"; private string _serverUrl = ""; private ISpeakeasyHttpClient _client; private Func? _securitySource; diff --git a/LukeHagar/PlexAPI/SDK/Server.cs b/LukeHagar/PlexAPI/SDK/Server.cs index 346413f..e858d49 100644 --- a/LukeHagar/PlexAPI/SDK/Server.cs +++ b/LukeHagar/PlexAPI/SDK/Server.cs @@ -126,10 +126,10 @@ namespace LukeHagar.PlexAPI.SDK { public SDKConfig SDKConfiguration { get; private set; } private const string _language = "csharp"; - private const string _sdkVersion = "0.14.7"; + private const string _sdkVersion = "0.14.9"; private const string _sdkGenVersion = "2.566.5"; private const string _openapiDocVersion = "0.0.3"; - private const string _userAgent = "speakeasy-sdk/csharp 0.14.7 2.566.5 0.0.3 LukeHagar.PlexAPI.SDK"; + private const string _userAgent = "speakeasy-sdk/csharp 0.14.9 2.566.5 0.0.3 LukeHagar.PlexAPI.SDK"; private string _serverUrl = ""; private ISpeakeasyHttpClient _client; private Func? _securitySource; diff --git a/LukeHagar/PlexAPI/SDK/Sessions.cs b/LukeHagar/PlexAPI/SDK/Sessions.cs index 841507f..9d5715b 100644 --- a/LukeHagar/PlexAPI/SDK/Sessions.cs +++ b/LukeHagar/PlexAPI/SDK/Sessions.cs @@ -80,10 +80,10 @@ namespace LukeHagar.PlexAPI.SDK { public SDKConfig SDKConfiguration { get; private set; } private const string _language = "csharp"; - private const string _sdkVersion = "0.14.7"; + private const string _sdkVersion = "0.14.9"; private const string _sdkGenVersion = "2.566.5"; private const string _openapiDocVersion = "0.0.3"; - private const string _userAgent = "speakeasy-sdk/csharp 0.14.7 2.566.5 0.0.3 LukeHagar.PlexAPI.SDK"; + private const string _userAgent = "speakeasy-sdk/csharp 0.14.9 2.566.5 0.0.3 LukeHagar.PlexAPI.SDK"; private string _serverUrl = ""; private ISpeakeasyHttpClient _client; private Func? _securitySource; diff --git a/LukeHagar/PlexAPI/SDK/Statistics.cs b/LukeHagar/PlexAPI/SDK/Statistics.cs index 83d56ff..4c4e9f0 100644 --- a/LukeHagar/PlexAPI/SDK/Statistics.cs +++ b/LukeHagar/PlexAPI/SDK/Statistics.cs @@ -71,10 +71,10 @@ namespace LukeHagar.PlexAPI.SDK { public SDKConfig SDKConfiguration { get; private set; } private const string _language = "csharp"; - private const string _sdkVersion = "0.14.7"; + private const string _sdkVersion = "0.14.9"; private const string _sdkGenVersion = "2.566.5"; private const string _openapiDocVersion = "0.0.3"; - private const string _userAgent = "speakeasy-sdk/csharp 0.14.7 2.566.5 0.0.3 LukeHagar.PlexAPI.SDK"; + private const string _userAgent = "speakeasy-sdk/csharp 0.14.9 2.566.5 0.0.3 LukeHagar.PlexAPI.SDK"; private string _serverUrl = ""; private ISpeakeasyHttpClient _client; private Func? _securitySource; diff --git a/LukeHagar/PlexAPI/SDK/Updater.cs b/LukeHagar/PlexAPI/SDK/Updater.cs index 34d5961..92c1caa 100644 --- a/LukeHagar/PlexAPI/SDK/Updater.cs +++ b/LukeHagar/PlexAPI/SDK/Updater.cs @@ -74,10 +74,10 @@ namespace LukeHagar.PlexAPI.SDK { public SDKConfig SDKConfiguration { get; private set; } private const string _language = "csharp"; - private const string _sdkVersion = "0.14.7"; + private const string _sdkVersion = "0.14.9"; private const string _sdkGenVersion = "2.566.5"; private const string _openapiDocVersion = "0.0.3"; - private const string _userAgent = "speakeasy-sdk/csharp 0.14.7 2.566.5 0.0.3 LukeHagar.PlexAPI.SDK"; + private const string _userAgent = "speakeasy-sdk/csharp 0.14.9 2.566.5 0.0.3 LukeHagar.PlexAPI.SDK"; private string _serverUrl = ""; private ISpeakeasyHttpClient _client; private Func? _securitySource; diff --git a/LukeHagar/PlexAPI/SDK/Users.cs b/LukeHagar/PlexAPI/SDK/Users.cs index 9fff6f2..2167afb 100644 --- a/LukeHagar/PlexAPI/SDK/Users.cs +++ b/LukeHagar/PlexAPI/SDK/Users.cs @@ -45,10 +45,10 @@ namespace LukeHagar.PlexAPI.SDK }; public SDKConfig SDKConfiguration { get; private set; } private const string _language = "csharp"; - private const string _sdkVersion = "0.14.7"; + private const string _sdkVersion = "0.14.9"; private const string _sdkGenVersion = "2.566.5"; private const string _openapiDocVersion = "0.0.3"; - private const string _userAgent = "speakeasy-sdk/csharp 0.14.7 2.566.5 0.0.3 LukeHagar.PlexAPI.SDK"; + private const string _userAgent = "speakeasy-sdk/csharp 0.14.9 2.566.5 0.0.3 LukeHagar.PlexAPI.SDK"; private string _serverUrl = ""; private ISpeakeasyHttpClient _client; private Func? _securitySource; diff --git a/LukeHagar/PlexAPI/SDK/Video.cs b/LukeHagar/PlexAPI/SDK/Video.cs index 8014977..d0fbb7e 100644 --- a/LukeHagar/PlexAPI/SDK/Video.cs +++ b/LukeHagar/PlexAPI/SDK/Video.cs @@ -62,10 +62,10 @@ namespace LukeHagar.PlexAPI.SDK { public SDKConfig SDKConfiguration { get; private set; } private const string _language = "csharp"; - private const string _sdkVersion = "0.14.7"; + private const string _sdkVersion = "0.14.9"; private const string _sdkGenVersion = "2.566.5"; private const string _openapiDocVersion = "0.0.3"; - private const string _userAgent = "speakeasy-sdk/csharp 0.14.7 2.566.5 0.0.3 LukeHagar.PlexAPI.SDK"; + private const string _userAgent = "speakeasy-sdk/csharp 0.14.9 2.566.5 0.0.3 LukeHagar.PlexAPI.SDK"; private string _serverUrl = ""; private ISpeakeasyHttpClient _client; private Func? _securitySource; diff --git a/LukeHagar/PlexAPI/SDK/Watchlist.cs b/LukeHagar/PlexAPI/SDK/Watchlist.cs index 016692e..dee8ab5 100644 --- a/LukeHagar/PlexAPI/SDK/Watchlist.cs +++ b/LukeHagar/PlexAPI/SDK/Watchlist.cs @@ -59,10 +59,10 @@ namespace LukeHagar.PlexAPI.SDK }; public SDKConfig SDKConfiguration { get; private set; } private const string _language = "csharp"; - private const string _sdkVersion = "0.14.7"; + private const string _sdkVersion = "0.14.9"; private const string _sdkGenVersion = "2.566.5"; private const string _openapiDocVersion = "0.0.3"; - private const string _userAgent = "speakeasy-sdk/csharp 0.14.7 2.566.5 0.0.3 LukeHagar.PlexAPI.SDK"; + private const string _userAgent = "speakeasy-sdk/csharp 0.14.9 2.566.5 0.0.3 LukeHagar.PlexAPI.SDK"; private string _serverUrl = ""; private ISpeakeasyHttpClient _client; private Func? _securitySource; diff --git a/RELEASES.md b/RELEASES.md index 03b6887..e5db73b 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -554,4 +554,14 @@ Based on: ### Generated - [csharp v0.14.7] . ### Releases -- [NuGet v0.14.7] https://www.nuget.org/packages/LukeHagar.PlexAPI.SDK/0.14.7 - . \ No newline at end of file +- [NuGet v0.14.7] https://www.nuget.org/packages/LukeHagar.PlexAPI.SDK/0.14.7 - . + +## 2025-04-19 00:22:04 +### Changes +Based on: +- OpenAPI Doc +- Speakeasy CLI 1.529.1 (2.566.5) https://github.com/speakeasy-api/speakeasy +### Generated +- [csharp v0.14.9] . +### Releases +- [NuGet v0.14.9] https://www.nuget.org/packages/LukeHagar.PlexAPI.SDK/0.14.9 - . \ No newline at end of file diff --git a/docs/Models/Requests/GetLibraryDetailsRequest.md b/docs/Models/Requests/GetLibraryDetailsRequest.md index 3574621..d87c6a9 100644 --- a/docs/Models/Requests/GetLibraryDetailsRequest.md +++ b/docs/Models/Requests/GetLibraryDetailsRequest.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `IncludeDetails` | [IncludeDetails](../../Models/Requests/IncludeDetails.md) | :heavy_minus_sign: | 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.
| | -| `SectionKey` | *int* | :heavy_check_mark: | The unique key of the Plex library.
Note: This is unique in the context of the Plex server.
| 9518 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `IncludeDetails` | [IncludeDetails](../../Models/Requests/IncludeDetails.md) | :heavy_minus_sign: | 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.
| | +| `SectionKey` | *int* | :heavy_check_mark: | The unique key of the Plex library.
Note: This is unique in the context of the Plex server.
| 9518 | \ No newline at end of file diff --git a/docs/Models/Requests/IncludeDetails.md b/docs/Models/Requests/IncludeDetails.md index 7085055..d865168 100644 --- a/docs/Models/Requests/IncludeDetails.md +++ b/docs/Models/Requests/IncludeDetails.md @@ -1,6 +1,6 @@ # IncludeDetails -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. diff --git a/docs/Models/Requests/Level.md b/docs/Models/Requests/Level.md index 29b6537..b2325df 100644 --- a/docs/Models/Requests/Level.md +++ b/docs/Models/Requests/Level.md @@ -1,10 +1,10 @@ # Level -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 diff --git a/docs/Models/Requests/LogLineRequest.md b/docs/Models/Requests/LogLineRequest.md index d7bd1e5..16d5414 100644 --- a/docs/Models/Requests/LogLineRequest.md +++ b/docs/Models/Requests/LogLineRequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | -| `Level` | [Level](../../Models/Requests/Level.md) | :heavy_check_mark: | An integer log level to write to the PMS log with.
0: Error
1: Warning
2: Info
3: Debug
4: Verbose
| | -| `Message` | *string* | :heavy_check_mark: | The text of the message to write to the log. | Test log message | -| `Source` | *string* | :heavy_check_mark: | a string indicating the source of the message. | Postman | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | +| `Level` | [Level](../../Models/Requests/Level.md) | :heavy_check_mark: | An integer log level to write to the PMS log with.
0: Error
1: Warning
2: Info
3: Debug
4: Verbose
| | +| `Message` | *string* | :heavy_check_mark: | The text of the message to write to the log. | Test log message | +| `Source` | *string* | :heavy_check_mark: | a string indicating the source of the message. | Postman | \ No newline at end of file diff --git a/docs/Models/Requests/QueryParamForce.md b/docs/Models/Requests/QueryParamForce.md index 703306e..0a8f8c4 100644 --- a/docs/Models/Requests/QueryParamForce.md +++ b/docs/Models/Requests/QueryParamForce.md @@ -1,8 +1,8 @@ # 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. +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. diff --git a/docs/Models/Requests/UploadPlaylistRequest.md b/docs/Models/Requests/UploadPlaylistRequest.md index 0a96e0f..bf42042 100644 --- a/docs/Models/Requests/UploadPlaylistRequest.md +++ b/docs/Models/Requests/UploadPlaylistRequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | 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.
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.
| /home/barkley/playlist.m3u | -| `Force` | [QueryParamForce](../../Models/Requests/QueryParamForce.md) | :heavy_check_mark: | 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.
| | -| `SectionID` | *long* | :heavy_check_mark: | Possibly the section ID to upload the playlist to, we are not certain. | 1 | \ No newline at end of file +| Field | 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.
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.
| /home/barkley/playlist.m3u | +| `Force` | [QueryParamForce](../../Models/Requests/QueryParamForce.md) | :heavy_check_mark: | 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.
| | +| `SectionID` | *long* | :heavy_check_mark: | Possibly the section ID to upload the playlist to, we are not certain. | 1 | \ No newline at end of file diff --git a/docs/sdks/library/README.md b/docs/sdks/library/README.md index 7114679..b77d344 100644 --- a/docs/sdks/library/README.md +++ b/docs/sdks/library/README.md @@ -165,14 +165,14 @@ var res = await sdk.Library.GetAllLibrariesAsync(); ## 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. @@ -223,10 +223,10 @@ var res = await sdk.Library.GetLibraryDetailsAsync( ### Parameters -| Parameter | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `SectionKey` | *int* | :heavy_check_mark: | The unique key of the Plex library.
Note: This is unique in the context of the Plex server.
| 9518 | -| `IncludeDetails` | [IncludeDetails](../../Models/Requests/IncludeDetails.md) | :heavy_minus_sign: | 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.
| | +| Parameter | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `SectionKey` | *int* | :heavy_check_mark: | The unique key of the Plex library.
Note: This is unique in the context of the Plex server.
| 9518 | +| `IncludeDetails` | [IncludeDetails](../../Models/Requests/IncludeDetails.md) | :heavy_minus_sign: | 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.
| | ### Response diff --git a/docs/sdks/log/README.md b/docs/sdks/log/README.md index 9cc402e..7cfaaa4 100644 --- a/docs/sdks/log/README.md +++ b/docs/sdks/log/README.md @@ -37,11 +37,11 @@ var res = await sdk.Log.LogLineAsync( ### Parameters -| Parameter | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | -| `Level` | [Level](../../Models/Requests/Level.md) | :heavy_check_mark: | An integer log level to write to the PMS log with.
0: Error
1: Warning
2: Info
3: Debug
4: Verbose
| | -| `Message` | *string* | :heavy_check_mark: | The text of the message to write to the log. | Test log message | -| `Source` | *string* | :heavy_check_mark: | a string indicating the source of the message. | Postman | +| Parameter | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | +| `Level` | [Level](../../Models/Requests/Level.md) | :heavy_check_mark: | An integer log level to write to the PMS log with.
0: Error
1: Warning
2: Info
3: Debug
4: Verbose
| | +| `Message` | *string* | :heavy_check_mark: | The text of the message to write to the log. | Test log message | +| `Source` | *string* | :heavy_check_mark: | a string indicating the source of the message. | Postman | ### Response @@ -57,13 +57,13 @@ var res = await sdk.Log.LogLineAsync( ## LogMultiLine -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. diff --git a/docs/sdks/playlists/README.md b/docs/sdks/playlists/README.md index 3d681b1..324ace6 100644 --- a/docs/sdks/playlists/README.md +++ b/docs/sdks/playlists/README.md @@ -3,9 +3,9 @@ ## Overview -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. @@ -370,11 +370,11 @@ var res = await sdk.Playlists.UploadPlaylistAsync( ### Parameters -| 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.
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.
| /home/barkley/playlist.m3u | -| `Force` | [QueryParamForce](../../Models/Requests/QueryParamForce.md) | :heavy_check_mark: | 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.
| | -| `SectionID` | *long* | :heavy_check_mark: | Possibly the section ID to upload the playlist to, we are not certain. | 1 | +| 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.
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.
| /home/barkley/playlist.m3u | +| `Force` | [QueryParamForce](../../Models/Requests/QueryParamForce.md) | :heavy_check_mark: | 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.
| | +| `SectionID` | *long* | :heavy_check_mark: | Possibly the section ID to upload the playlist to, we are not certain. | 1 | ### Response