//------------------------------------------------------------------------------ // // This code was generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT. // // Changes to this file may cause incorrect behavior and will be lost when // the code is regenerated. // //------------------------------------------------------------------------------ #nullable enable namespace PlexAPI { using Newtonsoft.Json; using PlexAPI.Models.Requests; using PlexAPI.Utils; using System.Net.Http.Headers; using System.Net.Http; using System.Threading.Tasks; using System; /// /// 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.
/// This may cause the duration and number of items to change.
/// ///
///
public interface IPlaylists { /// /// Create a Playlist /// /// /// Create a new playlist. By default the playlist is blank. To create a playlist along with a first item, pass:
/// - `uri` - The content URI for what we're playing (e.g. `library://...`).
/// - `playQueueID` - To create a playlist from an existing play queue.
/// ///
///
Task CreatePlaylistAsync(CreatePlaylistRequest? request = null); /// /// Get All Playlists /// /// /// Get All Playlists given the specified filters. /// /// Task GetPlaylistsAsync(PlaylistType? playlistType = null, QueryParamSmart? smart = null); /// /// Retrieve Playlist /// /// /// Gets detailed metadata for a playlist. A playlist for many purposes (rating, editing metadata, tagging), can be treated like a regular metadata item:
/// Smart playlist details contain the `content` attribute. This is the content URI for the generator. This can then be parsed by a client to provide smart playlist editing.
/// ///
///
Task GetPlaylistAsync(double playlistID); /// /// Deletes a Playlist /// /// /// This endpoint will delete a playlist
/// ///
///
Task DeletePlaylistAsync(double playlistID); /// /// Update a Playlist /// /// /// From PMS version 1.9.1 clients can also edit playlist metadata using this endpoint as they would via `PUT /library/metadata/{playlistID}`
/// ///
///
Task UpdatePlaylistAsync(double playlistID); /// /// Retrieve Playlist Contents /// /// /// Gets the contents of a playlist. Should be paged by clients via standard mechanisms.
/// By default leaves are returned (e.g. episodes, movies). In order to return other types you can use the `type` parameter.
/// For example, you could use this to display a list of recently added albums vis a smart playlist.
/// Note that for dumb playlists, items have a `playlistItemID` attribute which is used for deleting or moving items.
/// ///
///
Task GetPlaylistContentsAsync(double playlistID, double type); /// /// Delete Playlist Contents /// /// /// Clears a playlist, only works with dumb playlists. Returns the playlist.
/// ///
///
Task ClearPlaylistContentsAsync(double playlistID); /// /// Adding to a Playlist /// /// /// Adds a generator to a playlist, same parameters as the POST above. With a dumb playlist, this adds the specified items to the playlist.
/// With a smart playlist, passing a new `uri` parameter replaces the rules for the playlist. Returns the playlist.
/// ///
///
Task AddPlaylistContentsAsync(double playlistID, string uri, double playQueueID); /// /// Upload Playlist /// /// /// Imports m3u playlists by passing a path on the server to scan for m3u-formatted playlist files, or a path to a single playlist file.
/// ///
///
Task UploadPlaylistAsync(string path, Force force); } /// /// 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.
/// This may cause the duration and number of items to change.
/// ///
///
public class Playlists: IPlaylists { public SDKConfig SDKConfiguration { get; private set; } private const string _language = "csharp"; private const string _sdkVersion = "0.1.3"; private const string _sdkGenVersion = "2.237.2"; private const string _openapiDocVersion = "0.0.3"; private const string _userAgent = "speakeasy-sdk/csharp 0.1.3 2.237.2 0.0.3 Plex-API"; private string _serverUrl = ""; private ISpeakeasyHttpClient _defaultClient; private ISpeakeasyHttpClient _securityClient; public Playlists(ISpeakeasyHttpClient defaultClient, ISpeakeasyHttpClient securityClient, string serverUrl, SDKConfig config) { _defaultClient = defaultClient; _securityClient = securityClient; _serverUrl = serverUrl; SDKConfiguration = config; } public async Task CreatePlaylistAsync(CreatePlaylistRequest? request = null) { string baseUrl = this.SDKConfiguration.GetTemplatedServerDetails(); var urlString = URLBuilder.Build(baseUrl, "/playlists", request); var httpRequest = new HttpRequestMessage(HttpMethod.Post, urlString); httpRequest.Headers.Add("user-agent", _userAgent); var client = _securityClient; var httpResponse = await client.SendAsync(httpRequest); var contentType = httpResponse.Content.Headers.ContentType?.MediaType; var response = new CreatePlaylistResponse { StatusCode = (int)httpResponse.StatusCode, ContentType = contentType, RawResponse = httpResponse }; if((response.StatusCode == 200) || (response.StatusCode == 400)) { return response; } if((response.StatusCode == 401)) { if(Utilities.IsContentTypeMatch("application/json",response.ContentType)) { response.Object = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer(), new EnumSerializer() }}); } return response; } return response; } public async Task GetPlaylistsAsync(PlaylistType? playlistType = null, QueryParamSmart? smart = null) { var request = new GetPlaylistsRequest() { PlaylistType = playlistType, Smart = smart, }; string baseUrl = this.SDKConfiguration.GetTemplatedServerDetails(); var urlString = URLBuilder.Build(baseUrl, "/playlists/all", request); var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", _userAgent); var client = _securityClient; var httpResponse = await client.SendAsync(httpRequest); var contentType = httpResponse.Content.Headers.ContentType?.MediaType; var response = new GetPlaylistsResponse { StatusCode = (int)httpResponse.StatusCode, ContentType = contentType, RawResponse = httpResponse }; if((response.StatusCode == 200) || (response.StatusCode == 400)) { return response; } if((response.StatusCode == 401)) { if(Utilities.IsContentTypeMatch("application/json",response.ContentType)) { response.Object = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer(), new EnumSerializer() }}); } return response; } return response; } public async Task GetPlaylistAsync(double playlistID) { var request = new GetPlaylistRequest() { PlaylistID = playlistID, }; string baseUrl = this.SDKConfiguration.GetTemplatedServerDetails(); var urlString = URLBuilder.Build(baseUrl, "/playlists/{playlistID}", request); var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", _userAgent); var client = _securityClient; var httpResponse = await client.SendAsync(httpRequest); var contentType = httpResponse.Content.Headers.ContentType?.MediaType; var response = new GetPlaylistResponse { StatusCode = (int)httpResponse.StatusCode, ContentType = contentType, RawResponse = httpResponse }; if((response.StatusCode == 200) || (response.StatusCode == 400)) { return response; } if((response.StatusCode == 401)) { if(Utilities.IsContentTypeMatch("application/json",response.ContentType)) { response.Object = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer(), new EnumSerializer() }}); } return response; } return response; } public async Task DeletePlaylistAsync(double playlistID) { var request = new DeletePlaylistRequest() { PlaylistID = playlistID, }; string baseUrl = this.SDKConfiguration.GetTemplatedServerDetails(); var urlString = URLBuilder.Build(baseUrl, "/playlists/{playlistID}", request); var httpRequest = new HttpRequestMessage(HttpMethod.Delete, urlString); httpRequest.Headers.Add("user-agent", _userAgent); var client = _securityClient; var httpResponse = await client.SendAsync(httpRequest); var contentType = httpResponse.Content.Headers.ContentType?.MediaType; var response = new DeletePlaylistResponse { StatusCode = (int)httpResponse.StatusCode, ContentType = contentType, RawResponse = httpResponse }; if((response.StatusCode == 200) || (response.StatusCode == 400)) { return response; } if((response.StatusCode == 401)) { if(Utilities.IsContentTypeMatch("application/json",response.ContentType)) { response.Object = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer(), new EnumSerializer() }}); } return response; } return response; } public async Task UpdatePlaylistAsync(double playlistID) { var request = new UpdatePlaylistRequest() { PlaylistID = playlistID, }; string baseUrl = this.SDKConfiguration.GetTemplatedServerDetails(); var urlString = URLBuilder.Build(baseUrl, "/playlists/{playlistID}", request); var httpRequest = new HttpRequestMessage(HttpMethod.Put, urlString); httpRequest.Headers.Add("user-agent", _userAgent); var client = _securityClient; var httpResponse = await client.SendAsync(httpRequest); var contentType = httpResponse.Content.Headers.ContentType?.MediaType; var response = new UpdatePlaylistResponse { StatusCode = (int)httpResponse.StatusCode, ContentType = contentType, RawResponse = httpResponse }; if((response.StatusCode == 200) || (response.StatusCode == 400)) { return response; } if((response.StatusCode == 401)) { if(Utilities.IsContentTypeMatch("application/json",response.ContentType)) { response.Object = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer(), new EnumSerializer() }}); } return response; } return response; } public async Task GetPlaylistContentsAsync(double playlistID, double type) { var request = new GetPlaylistContentsRequest() { PlaylistID = playlistID, Type = type, }; string baseUrl = this.SDKConfiguration.GetTemplatedServerDetails(); var urlString = URLBuilder.Build(baseUrl, "/playlists/{playlistID}/items", request); var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", _userAgent); var client = _securityClient; var httpResponse = await client.SendAsync(httpRequest); var contentType = httpResponse.Content.Headers.ContentType?.MediaType; var response = new GetPlaylistContentsResponse { StatusCode = (int)httpResponse.StatusCode, ContentType = contentType, RawResponse = httpResponse }; if((response.StatusCode == 200) || (response.StatusCode == 400)) { return response; } if((response.StatusCode == 401)) { if(Utilities.IsContentTypeMatch("application/json",response.ContentType)) { response.Object = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer(), new EnumSerializer() }}); } return response; } return response; } public async Task ClearPlaylistContentsAsync(double playlistID) { var request = new ClearPlaylistContentsRequest() { PlaylistID = playlistID, }; string baseUrl = this.SDKConfiguration.GetTemplatedServerDetails(); var urlString = URLBuilder.Build(baseUrl, "/playlists/{playlistID}/items", request); var httpRequest = new HttpRequestMessage(HttpMethod.Delete, urlString); httpRequest.Headers.Add("user-agent", _userAgent); var client = _securityClient; var httpResponse = await client.SendAsync(httpRequest); var contentType = httpResponse.Content.Headers.ContentType?.MediaType; var response = new ClearPlaylistContentsResponse { StatusCode = (int)httpResponse.StatusCode, ContentType = contentType, RawResponse = httpResponse }; if((response.StatusCode == 200) || (response.StatusCode == 400)) { return response; } if((response.StatusCode == 401)) { if(Utilities.IsContentTypeMatch("application/json",response.ContentType)) { response.Object = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer(), new EnumSerializer() }}); } return response; } return response; } public async Task AddPlaylistContentsAsync(double playlistID, string uri, double playQueueID) { var request = new AddPlaylistContentsRequest() { PlaylistID = playlistID, Uri = uri, PlayQueueID = playQueueID, }; string baseUrl = this.SDKConfiguration.GetTemplatedServerDetails(); var urlString = URLBuilder.Build(baseUrl, "/playlists/{playlistID}/items", request); var httpRequest = new HttpRequestMessage(HttpMethod.Put, urlString); httpRequest.Headers.Add("user-agent", _userAgent); var client = _securityClient; var httpResponse = await client.SendAsync(httpRequest); var contentType = httpResponse.Content.Headers.ContentType?.MediaType; var response = new AddPlaylistContentsResponse { StatusCode = (int)httpResponse.StatusCode, ContentType = contentType, RawResponse = httpResponse }; if((response.StatusCode == 200) || (response.StatusCode == 400)) { return response; } if((response.StatusCode == 401)) { if(Utilities.IsContentTypeMatch("application/json",response.ContentType)) { response.Object = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer(), new EnumSerializer() }}); } return response; } return response; } public async Task UploadPlaylistAsync(string path, Force force) { var request = new UploadPlaylistRequest() { Path = path, Force = force, }; string baseUrl = this.SDKConfiguration.GetTemplatedServerDetails(); var urlString = URLBuilder.Build(baseUrl, "/playlists/upload", request); var httpRequest = new HttpRequestMessage(HttpMethod.Post, urlString); httpRequest.Headers.Add("user-agent", _userAgent); var client = _securityClient; var httpResponse = await client.SendAsync(httpRequest); var contentType = httpResponse.Content.Headers.ContentType?.MediaType; var response = new UploadPlaylistResponse { StatusCode = (int)httpResponse.StatusCode, ContentType = contentType, RawResponse = httpResponse }; if((response.StatusCode == 200) || (response.StatusCode == 400)) { return response; } if((response.StatusCode == 401)) { if(Utilities.IsContentTypeMatch("application/json",response.ContentType)) { response.Object = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer(), new EnumSerializer() }}); } return response; } return response; } } }