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

ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.526.6

Browse Source
This commit is contained in:
speakeasybot
2025-03-31 17:09:11 +00:00
parent c2eeb488c4
commit 04db2979db
1059 changed files with 9590 additions and 8278 deletions
Download Patch File Download Diff File Expand all files Collapse all files

140
src/main/java/dev/plexapi/sdk/Playlists.java
View File

@@ -1,7 +1,6 @@
/*
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
*/
package dev.plexapi.sdk;
import com.fasterxml.jackson.core.type.TypeReference;
@@ -74,14 +73,15 @@ import java.lang.String;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.util.List;
import java.util.Optional;
import java.util.Optional;
/**
* 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 implements
MethodCallCreatePlaylist,
@@ -103,7 +103,8 @@ public class Playlists implements
/**
* Create a Playlist
* Create a new playlist. By default the playlist is blank. To create a playlist along with a first item, pass:
*
* <p>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. `server://1234/com.plexapp.plugins.library/library/metadata/1`).
* - `playQueueID` - To create a playlist from an existing play queue.
*
@@ -115,7 +116,8 @@ public class Playlists implements
/**
* Create a Playlist
* Create a new playlist. By default the playlist is blank. To create a playlist along with a first item, pass:
*
* <p>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. `server://1234/com.plexapp.plugins.library/library/metadata/1`).
* - `playQueueID` - To create a playlist from an existing play queue.
*
@@ -149,6 +151,7 @@ public class Playlists implements
sdkConfiguration.hooks()
.beforeRequest(
new BeforeRequestContextImpl(
_baseUrl,
"createPlaylist",
Optional.of(List.of()),
_hookSecuritySource),
@@ -160,6 +163,7 @@ public class Playlists implements
_httpRes = sdkConfiguration.hooks()
.afterError(
new AfterErrorContextImpl(
_baseUrl,
"createPlaylist",
Optional.of(List.of()),
_hookSecuritySource),
@@ -169,6 +173,7 @@ public class Playlists implements
_httpRes = sdkConfiguration.hooks()
.afterSuccess(
new AfterSuccessContextImpl(
_baseUrl,
"createPlaylist",
Optional.of(List.of()),
_hookSecuritySource),
@@ -178,6 +183,7 @@ public class Playlists implements
_httpRes = sdkConfiguration.hooks()
.afterError(
new AfterErrorContextImpl(
_baseUrl,
"createPlaylist",
Optional.of(List.of()),
_hookSecuritySource),
@@ -271,7 +277,9 @@ public class Playlists implements
/**
* Get All Playlists
* Get All Playlists given the specified filters.
*
* <p>Get All Playlists given the specified filters.
*
* @return The call builder
*/
public GetPlaylistsRequestBuilder getPlaylists() {
@@ -280,7 +288,9 @@ public class Playlists implements
/**
* Get All Playlists
* Get All Playlists given the specified filters.
*
* <p>Get All Playlists given the specified filters.
*
* @return The response from the API call
* @throws Exception if the API call fails
*/
@@ -290,7 +300,9 @@ public class Playlists implements
/**
* Get All Playlists
* Get All Playlists given the specified filters.
*
* <p>Get All Playlists given the specified filters.
*
* @param playlistType limit to a type of playlist.
* @param smart type of playlists to return (default is all).
* @return The response from the API call
@@ -330,6 +342,7 @@ public class Playlists implements
sdkConfiguration.hooks()
.beforeRequest(
new BeforeRequestContextImpl(
_baseUrl,
"getPlaylists",
Optional.of(List.of()),
_hookSecuritySource),
@@ -341,6 +354,7 @@ public class Playlists implements
_httpRes = sdkConfiguration.hooks()
.afterError(
new AfterErrorContextImpl(
_baseUrl,
"getPlaylists",
Optional.of(List.of()),
_hookSecuritySource),
@@ -350,6 +364,7 @@ public class Playlists implements
_httpRes = sdkConfiguration.hooks()
.afterSuccess(
new AfterSuccessContextImpl(
_baseUrl,
"getPlaylists",
Optional.of(List.of()),
_hookSecuritySource),
@@ -359,6 +374,7 @@ public class Playlists implements
_httpRes = sdkConfiguration.hooks()
.afterError(
new AfterErrorContextImpl(
_baseUrl,
"getPlaylists",
Optional.of(List.of()),
_hookSecuritySource),
@@ -452,7 +468,8 @@ public class Playlists implements
/**
* 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:
*
* <p>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.
*
* @return The call builder
@@ -463,7 +480,8 @@ public class Playlists implements
/**
* 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:
*
* <p>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.
*
* @param playlistID the ID of the playlist
@@ -499,6 +517,7 @@ public class Playlists implements
sdkConfiguration.hooks()
.beforeRequest(
new BeforeRequestContextImpl(
_baseUrl,
"getPlaylist",
Optional.of(List.of()),
_hookSecuritySource),
@@ -510,6 +529,7 @@ public class Playlists implements
_httpRes = sdkConfiguration.hooks()
.afterError(
new AfterErrorContextImpl(
_baseUrl,
"getPlaylist",
Optional.of(List.of()),
_hookSecuritySource),
@@ -519,6 +539,7 @@ public class Playlists implements
_httpRes = sdkConfiguration.hooks()
.afterSuccess(
new AfterSuccessContextImpl(
_baseUrl,
"getPlaylist",
Optional.of(List.of()),
_hookSecuritySource),
@@ -528,6 +549,7 @@ public class Playlists implements
_httpRes = sdkConfiguration.hooks()
.afterError(
new AfterErrorContextImpl(
_baseUrl,
"getPlaylist",
Optional.of(List.of()),
_hookSecuritySource),
@@ -621,7 +643,8 @@ public class Playlists implements
/**
* Deletes a Playlist
* This endpoint will delete a playlist
*
* <p>This endpoint will delete a playlist
*
* @return The call builder
*/
@@ -631,7 +654,8 @@ public class Playlists implements
/**
* Deletes a Playlist
* This endpoint will delete a playlist
*
* <p>This endpoint will delete a playlist
*
* @param playlistID the ID of the playlist
* @return The response from the API call
@@ -666,6 +690,7 @@ public class Playlists implements
sdkConfiguration.hooks()
.beforeRequest(
new BeforeRequestContextImpl(
_baseUrl,
"deletePlaylist",
Optional.of(List.of()),
_hookSecuritySource),
@@ -677,6 +702,7 @@ public class Playlists implements
_httpRes = sdkConfiguration.hooks()
.afterError(
new AfterErrorContextImpl(
_baseUrl,
"deletePlaylist",
Optional.of(List.of()),
_hookSecuritySource),
@@ -686,6 +712,7 @@ public class Playlists implements
_httpRes = sdkConfiguration.hooks()
.afterSuccess(
new AfterSuccessContextImpl(
_baseUrl,
"deletePlaylist",
Optional.of(List.of()),
_hookSecuritySource),
@@ -695,6 +722,7 @@ public class Playlists implements
_httpRes = sdkConfiguration.hooks()
.afterError(
new AfterErrorContextImpl(
_baseUrl,
"deletePlaylist",
Optional.of(List.of()),
_hookSecuritySource),
@@ -777,7 +805,8 @@ public class Playlists implements
/**
* 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}`
*
* <p>From PMS version 1.9.1 clients can also edit playlist metadata using this endpoint as they would via `PUT /library/metadata/{playlistID}`
*
* @return The call builder
*/
@@ -787,7 +816,8 @@ public class Playlists implements
/**
* 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}`
*
* <p>From PMS version 1.9.1 clients can also edit playlist metadata using this endpoint as they would via `PUT /library/metadata/{playlistID}`
*
* @param playlistID the ID of the playlist
* @return The response from the API call
@@ -800,7 +830,8 @@ public class Playlists implements
/**
* 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}`
*
* <p>From PMS version 1.9.1 clients can also edit playlist metadata using this endpoint as they would via `PUT /library/metadata/{playlistID}`
*
* @param playlistID the ID of the playlist
* @param title name of the playlist
@@ -846,6 +877,7 @@ public class Playlists implements
sdkConfiguration.hooks()
.beforeRequest(
new BeforeRequestContextImpl(
_baseUrl,
"updatePlaylist",
Optional.of(List.of()),
_hookSecuritySource),
@@ -857,6 +889,7 @@ public class Playlists implements
_httpRes = sdkConfiguration.hooks()
.afterError(
new AfterErrorContextImpl(
_baseUrl,
"updatePlaylist",
Optional.of(List.of()),
_hookSecuritySource),
@@ -866,6 +899,7 @@ public class Playlists implements
_httpRes = sdkConfiguration.hooks()
.afterSuccess(
new AfterSuccessContextImpl(
_baseUrl,
"updatePlaylist",
Optional.of(List.of()),
_hookSecuritySource),
@@ -875,6 +909,7 @@ public class Playlists implements
_httpRes = sdkConfiguration.hooks()
.afterError(
new AfterErrorContextImpl(
_baseUrl,
"updatePlaylist",
Optional.of(List.of()),
_hookSecuritySource),
@@ -957,7 +992,8 @@ public class Playlists implements
/**
* Retrieve Playlist Contents
* Gets the contents of a playlist. Should be paged by clients via standard mechanisms.
*
* <p>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.
@@ -970,19 +1006,20 @@ public class Playlists implements
/**
* Retrieve Playlist Contents
* Gets the contents of a playlist. Should be paged by clients via standard mechanisms.
*
* <p>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.
*
* @param playlistID the ID of the playlist
* @param type The type of media to retrieve or filter by.
1 = movie
2 = show
3 = season
4 = episode
E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
* 1 = movie
* 2 = show
* 3 = season
* 4 = episode
* E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
*
* @return The response from the API call
* @throws Exception if the API call fails
*/
@@ -1022,6 +1059,7 @@ public class Playlists implements
sdkConfiguration.hooks()
.beforeRequest(
new BeforeRequestContextImpl(
_baseUrl,
"getPlaylistContents",
Optional.of(List.of()),
_hookSecuritySource),
@@ -1033,6 +1071,7 @@ public class Playlists implements
_httpRes = sdkConfiguration.hooks()
.afterError(
new AfterErrorContextImpl(
_baseUrl,
"getPlaylistContents",
Optional.of(List.of()),
_hookSecuritySource),
@@ -1042,6 +1081,7 @@ public class Playlists implements
_httpRes = sdkConfiguration.hooks()
.afterSuccess(
new AfterSuccessContextImpl(
_baseUrl,
"getPlaylistContents",
Optional.of(List.of()),
_hookSecuritySource),
@@ -1051,6 +1091,7 @@ public class Playlists implements
_httpRes = sdkConfiguration.hooks()
.afterError(
new AfterErrorContextImpl(
_baseUrl,
"getPlaylistContents",
Optional.of(List.of()),
_hookSecuritySource),
@@ -1144,7 +1185,8 @@ public class Playlists implements
/**
* Delete Playlist Contents
* Clears a playlist, only works with dumb playlists. Returns the playlist.
*
* <p>Clears a playlist, only works with dumb playlists. Returns the playlist.
*
* @return The call builder
*/
@@ -1154,7 +1196,8 @@ public class Playlists implements
/**
* Delete Playlist Contents
* Clears a playlist, only works with dumb playlists. Returns the playlist.
*
* <p>Clears a playlist, only works with dumb playlists. Returns the playlist.
*
* @param playlistID the ID of the playlist
* @return The response from the API call
@@ -1189,6 +1232,7 @@ public class Playlists implements
sdkConfiguration.hooks()
.beforeRequest(
new BeforeRequestContextImpl(
_baseUrl,
"clearPlaylistContents",
Optional.of(List.of()),
_hookSecuritySource),
@@ -1200,6 +1244,7 @@ public class Playlists implements
_httpRes = sdkConfiguration.hooks()
.afterError(
new AfterErrorContextImpl(
_baseUrl,
"clearPlaylistContents",
Optional.of(List.of()),
_hookSecuritySource),
@@ -1209,6 +1254,7 @@ public class Playlists implements
_httpRes = sdkConfiguration.hooks()
.afterSuccess(
new AfterSuccessContextImpl(
_baseUrl,
"clearPlaylistContents",
Optional.of(List.of()),
_hookSecuritySource),
@@ -1218,6 +1264,7 @@ public class Playlists implements
_httpRes = sdkConfiguration.hooks()
.afterError(
new AfterErrorContextImpl(
_baseUrl,
"clearPlaylistContents",
Optional.of(List.of()),
_hookSecuritySource),
@@ -1300,7 +1347,8 @@ public class Playlists implements
/**
* Adding to a Playlist
* Adds a generator to a playlist, same parameters as the POST to create. With a dumb playlist, this adds the specified items to the playlist.
*
* <p>Adds a generator to a playlist, same parameters as the POST to create. 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.
*
* @return The call builder
@@ -1311,7 +1359,8 @@ public class Playlists implements
/**
* Adding to a Playlist
* Adds a generator to a playlist, same parameters as the POST to create. With a dumb playlist, this adds the specified items to the playlist.
*
* <p>Adds a generator to a playlist, same parameters as the POST to create. 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.
*
* @param playlistID the ID of the playlist
@@ -1327,7 +1376,8 @@ public class Playlists implements
/**
* Adding to a Playlist
* Adds a generator to a playlist, same parameters as the POST to create. With a dumb playlist, this adds the specified items to the playlist.
*
* <p>Adds a generator to a playlist, same parameters as the POST to create. 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.
*
* @param playlistID the ID of the playlist
@@ -1374,6 +1424,7 @@ public class Playlists implements
sdkConfiguration.hooks()
.beforeRequest(
new BeforeRequestContextImpl(
_baseUrl,
"addPlaylistContents",
Optional.of(List.of()),
_hookSecuritySource),
@@ -1385,6 +1436,7 @@ public class Playlists implements
_httpRes = sdkConfiguration.hooks()
.afterError(
new AfterErrorContextImpl(
_baseUrl,
"addPlaylistContents",
Optional.of(List.of()),
_hookSecuritySource),
@@ -1394,6 +1446,7 @@ public class Playlists implements
_httpRes = sdkConfiguration.hooks()
.afterSuccess(
new AfterSuccessContextImpl(
_baseUrl,
"addPlaylistContents",
Optional.of(List.of()),
_hookSecuritySource),
@@ -1403,6 +1456,7 @@ public class Playlists implements
_httpRes = sdkConfiguration.hooks()
.afterError(
new AfterErrorContextImpl(
_baseUrl,
"addPlaylistContents",
Optional.of(List.of()),
_hookSecuritySource),
@@ -1496,7 +1550,8 @@ public class Playlists implements
/**
* 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.
*
* <p>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.
*
* @return The call builder
*/
@@ -1506,20 +1561,21 @@ public class Playlists implements
/**
* 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.
*
* <p>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.
*
* @param path 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.
* 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.
*
* @param force 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.
* 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.
*
* @param sectionID Possibly the section ID to upload the playlist to, we are not certain.
* @return The response from the API call
* @throws Exception if the API call fails
@@ -1560,6 +1616,7 @@ public class Playlists implements
sdkConfiguration.hooks()
.beforeRequest(
new BeforeRequestContextImpl(
_baseUrl,
"uploadPlaylist",
Optional.of(List.of()),
_hookSecuritySource),
@@ -1571,6 +1628,7 @@ public class Playlists implements
_httpRes = sdkConfiguration.hooks()
.afterError(
new AfterErrorContextImpl(
_baseUrl,
"uploadPlaylist",
Optional.of(List.of()),
_hookSecuritySource),
@@ -1580,6 +1638,7 @@ public class Playlists implements
_httpRes = sdkConfiguration.hooks()
.afterSuccess(
new AfterSuccessContextImpl(
_baseUrl,
"uploadPlaylist",
Optional.of(List.of()),
_hookSecuritySource),
@@ -1589,6 +1648,7 @@ public class Playlists implements
_httpRes = sdkConfiguration.hooks()
.afterError(
new AfterErrorContextImpl(
_baseUrl,
"uploadPlaylist",
Optional.of(List.of()),
_hookSecuritySource),