javascript-ampache 1.2.0 → 2.0.0

package/src/catalogs.js

@@ -0,0 +1,133 @@
+/**
+ * @typedef {Object} CatalogResponse
+ * @property {import("./base.js").UID} id
+ * @property {string} name
+ * @property {"local"|"remote"} type
+ * @property {"podcast"|"clip"|"tvshow"|"movie"|"personal_video"|"music"} gather_types
+ * @property {boolean} enabled
+ * @property {number} last_add
+ * @property {number} last_clean
+ * @property {number} last_update
+ * @property {string} path
+ * @property {string} rename_pattern
+ * @property {string} sort_pattern
+ */
+
+/**
+ * @typedef {Object} CatalogsResponse
+ * @property {number} total_count
+ * @property {string} md5
+ * @property {CatalogResponse[]} catalog
+ */
+
+export const catalogsMethods = {
+  /**
+   * This searches the catalogs and returns... catalogs
+   * @remarks MINIMUM_API_VERSION=420000
+   * @param {Object} [params]
+   * @param {"music"|"clip"|"tvshow"|"movie"|"personal_video"|"podcast"} [params.filter] Catalog type
+   * @param {number} [params.offset]
+   * @param {number} [params.limit]
+   * @param {string} [params.cond]
+   * @param {string} [params.sort]
+   * @returns {Promise<CatalogsResponse>}
+   * @see {@link https://ampache.org/api/api-json-methods#catalogs}
+   */
+  catalogs(params) {
+    return this.call("catalogs", params);
+  },
+
+  /**
+   * Return catalog by UID
+   * @remarks MINIMUM_API_VERSION=420000
+   * @param {Object} params
+   * @param {import("./base.js").UID} params.filter UID to find
+   * @returns {Promise<CatalogResponse>}
+   * @see {@link https://ampache.org/api/api-json-methods#catalog}
+   */
+  catalog(params) {
+    return this.call("catalog", params);
+  },
+
+  /**
+   * Kick off a catalog update or clean for the selected catalog
+   * ACCESS REQUIRED: 75 (Catalog Manager)
+   * @remarks MINIMUM_API_VERSION=400001
+   * @param {Object} params
+   * @param {"add_to_catalog"|"clean_catalog"} params.task add_to_catalog, clean_catalog
+   * @param {import("./base.js").UID} params.catalog UID of catalog
+   * @param {import("./base.js").UID} [params.filter] Alias of catalog (Ampache 7.9.0+)
+   * @returns {Promise<import("./base.js").Success>}
+   * @see {@link https://ampache.org/api/api-json-methods#catalog_action}
+   */
+  catalogAction(params) {
+    return this.call("catalog_action", params);
+  },
+
+  /**
+   * Perform actions on local catalog files. Single file versions of catalog add, clean, verify and remove (delete).
+   * Make sure you remember to urlencode those file names!
+   * ACCESS REQUIRED: 50 (Content Manager)
+   * @remarks MINIMUM_API_VERSION=420000
+   * @param {Object} params
+   * @param {string} params.file FULL path to local file
+   * @param {string} params.task add, clean, verify, remove, (can include comma-separated values)
+   * @param {import("./base.js").UID} params.catalog UID of catalog
+   * @param {import("./base.js").UID} [params.filter] Alias of catalog (Ampache 7.9.0+)
+   * @returns {Promise<import("./base.js").Success>}
+   * @see {@link https://ampache.org/api/api-json-methods#catalog_file}
+   */
+  catalogFile(params) {
+    return this.call("catalog_file", params);
+  },
+
+  /**
+   * Perform actions on local catalog folders. Single folder versions of catalog add, clean, verify and remove (delete).
+   * Make sure you remember to urlencode those folder names!
+   * ACCESS REQUIRED: 50 (Content Manager)
+   * @remarks MINIMUM_API_VERSION=420000
+   * @param {Object} params
+   * @param {string} params.folder FULL path to local folder
+   * @param {string} params.task add, clean, verify, remove, (can include comma-separated values)
+   * @param {import("./base.js").UID} params.catalog UID of catalog
+   * @param {import("./base.js").UID} [params.filter] Alias of catalog (Ampache 7.9.0+)
+   * @returns {Promise<import("./base.js").Success>}
+   * @see {@link https://ampache.org/api/api-json-methods#catalog_folder}
+   */
+  catalogFolder(params) {
+    return this.call("catalog_folder", params);
+  },
+
+  /**
+   * Create a new catalog.
+   * ACCESS REQUIRED: 75 (Catalog Manager)
+   * @remarks MINIMUM_API_VERSION=6.0.0
+   * @param {Object} params
+   * @param {string} params.name Name for the catalog
+   * @param {string} params.path URL or folder path for your catalog
+   * @param {"local"|"beets"|"remote"|"subsonic"|"seafile"|"beetsremote"} [params.type] Default: 'local'
+   * @param {"music"|"podcast"|"clip"|"tvshow"|"movie"|"personal_video"} [params.media_type] Default: 'music'
+   * @param {string} [params.file_pattern] Pattern used identify tags from the file name. Default: '%T - %t'
+   * @param {string} [params.folder_pattern] Pattern used identify tags from the folder name. Default: '%a/%A'
+   * @param {string} [params.username] login to remote catalog
+   * @param {string} [params.password] password to remote catalog
+   * @returns {Promise<CatalogResponse>}
+   * @see {@link https://ampache.org/api/api-json-methods#catalog_add}
+   */
+  catalogAdd(params) {
+    return this.call("catalog_add", params);
+  },
+
+  /**
+   * Delete an existing catalog. (if it exists)
+   * ACCESS REQUIRED: 75 (Catalog Manager)
+   * @remarks MINIMUM_API_VERSION=6.0.0
+   * @param {Object} params
+   * @param {import("./base.js").UID} params.filter ID of the catalog
+   * @returns {Promise<import("./base.js").Success>}
+   * @see {@link https://ampache.org/api/api-json-methods#catalog_delete}
+   */
+  catalogDelete(params) {
+    return this.call("catalog_delete", params);
+  },
+};

package/src/genres.js

@@ -0,0 +1,57 @@
+/**
+ * @typedef {Object} GenreSummary
+ * @property {import("./base.js").UID} id
+ * @property {string} name
+ */
+
+/**
+ * @typedef {Object} GenreResponse
+ * @property {import("./base.js").UID} id
+ * @property {string} name
+ * @property {number} albums
+ * @property {number} artists
+ * @property {number} songs
+ * @property {number} videos
+ * @property {number} playlists
+ * @property {number} live_streams
+ * @property {boolean} is_hidden
+ * @property {GenreSummary[]} merge
+ */
+
+/**
+ * @typedef {Object} GenresResponse
+ * @property {number} total_count
+ * @property {string} md5
+ * @property {GenreResponse[]} genre
+ */
+
+export const genresMethods = {
+  /**
+   * This returns the genres (Tags) based on the specified filter
+   * @remarks MINIMUM_API_VERSION=380001
+   * @param {Object} [params]
+   * @param {string} [params.filter] UID to find
+   * @param {import("./base.js").BinaryBoolean} [params.exact] 0, 1 (if true filter is exact = rather than fuzzy LIKE)
+   * @param {number} [params.offset]
+   * @param {number} [params.limit]
+   * @param {string} [params.cond]
+   * @param {string} [params.sort]
+   * @returns {Promise<GenresResponse>}
+   * @see {@link https://ampache.org/api/api-json-methods#genres}
+   */
+  genres(params) {
+    return this.call("genres", params);
+  },
+
+  /**
+   * This returns a single genre based on UID
+   * @remarks MINIMUM_API_VERSION=380001
+   * @param {Object} params
+   * @param {import("./base.js").UID} params.filter UID to find
+   * @returns {Promise<GenreResponse>}
+   * @see {@link https://ampache.org/api/api-json-methods#genre}
+   */
+  genre(params) {
+    return this.call("genre", params);
+  },
+};

package/src/index.js

@@ -0,0 +1,30 @@
+import { albumsMethods } from "./albums.js";
+import { artistsMethods } from "./artists.js";
+import { authMethods } from "./auth.js";
+import { bookmarksMethods } from "./bookmarks.js";
+import { catalogsMethods } from "./catalogs.js";
+import { genresMethods } from "./genres.js";
+import { labelsMethods } from "./labels.js";
+import { licensesMethods } from "./licenses.js";
+import { liveStreamsMethods } from "./live-streams.js";
+import { playlistsMethods } from "./playlists.js";
+import { podcastsMethods } from "./podcasts.js";
+import { preferencesMethods } from "./preferences.js";
+import { sharesMethods } from "./shares.js";
+import { shoutsMethods } from "./shouts.js";
+import { songsMethods } from "./songs.js";
+import { systemMethods } from "./system.js";
+import { usersMethods } from "./users.js";
+import { videosMethods } from "./videos.js";
+import { Base } from "./base.js";
+
+/**
+ * @typedef {Base} AmpacheAPI
+ * AmpacheAPI extends Base and has all domain methods (albums, artists, auth, etc.) on its prototype.
+ */
+
+class AmpacheAPI extends Base {}
+
+Object.assign(AmpacheAPI.prototype, albumsMethods, artistsMethods, authMethods, bookmarksMethods, catalogsMethods, genresMethods, labelsMethods, licensesMethods, liveStreamsMethods, playlistsMethods, podcastsMethods, preferencesMethods, sharesMethods, shoutsMethods, songsMethods, systemMethods, usersMethods, videosMethods);
+
+export default AmpacheAPI;

package/src/labels.js

@@ -0,0 +1,53 @@
+/**
+ * @typedef {Object} LabelResponse
+ * @property {import("./base.js").UID} id
+ * @property {string} name
+ * @property {number} artists
+ * @property {string|null} summary
+ * @property {string|null} external_link
+ * @property {string|null} address
+ * @property {string|null} category
+ * @property {string|null} email
+ * @property {string|null} website
+ * @property {import("./base.js").UID} user
+ */
+
+/**
+ * @typedef {Object} LabelsResponse
+ * @property {number} total_count
+ * @property {string} md5
+ * @property {LabelResponse[]} label
+ */
+
+export const labelsMethods = {
+  /**
+   * This returns labels based on the specified filter
+   * @remarks MINIMUM_API_VERSION=420000
+   * @param {Object} [params]
+   * @param {string} [params.filter] Filter results to match this string
+   * @param {import("./base.js").BinaryBoolean} [params.exact] 0, 1 (if true filter is exact = rather than fuzzy LIKE)
+   * @param {Date} [params.add] ISO 8601 Date Format (2020-09-16) Find objects with an 'add' date newer than the specified date
+   * @param {Date} [params.update] ISO 8601 Date Format (2020-09-16) Find objects with an 'update' time newer than the specified date
+   * @param {number} [params.offset]
+   * @param {number} [params.limit]
+   * @param {string} [params.cond]
+   * @param {string} [params.sort]
+   * @returns {Promise<LabelsResponse>}
+   * @see {@link https://ampache.org/api/api-json-methods#labels}
+   */
+  labels(params) {
+    return this.call("labels", params);
+  },
+
+  /**
+   * This returns a single label
+   * @remarks MINIMUM_API_VERSION=420000
+   * @param {Object} params
+   * @param {import("./base.js").UID} params.filter UID to find
+   * @returns {Promise<LabelResponse>}
+   * @see {@link https://ampache.org/api/api-json-methods#label}
+   */
+  label(params) {
+    return this.call("label", params);
+  },
+};

package/src/licenses.js

@@ -0,0 +1,47 @@
+/**
+ * @typedef {Object} LicenseResponse
+ * @property {import("./base.js").UID} id
+ * @property {string} name
+ * @property {string} description
+ * @property {string} external_link
+ */
+
+/**
+ * @typedef {Object} LicensesResponse
+ * @property {number} total_count
+ * @property {string} md5
+ * @property {LicenseResponse[]} license
+ */
+
+export const licensesMethods = {
+  /**
+   * This returns licenses based on the specified filter
+   * @remarks MINIMUM_API_VERSION=420000
+   * @param {Object} [params]
+   * @param {string} [params.filter] Filter results to match this string
+   * @param {import("./base.js").BinaryBoolean} [params.exact] 0, 1 (if true filter is exact = rather than fuzzy LIKE)
+   * @param {Date} [params.add] ISO 8601 Date Format (2020-09-16) Find objects with an 'add' date newer than the specified date
+   * @param {Date} [params.update] ISO 8601 Date Format (2020-09-16) Find objects with an 'update' time newer than the specified date
+   * @param {number} [params.offset]
+   * @param {number} [params.limit]
+   * @param {string} [params.cond]
+   * @param {string} [params.sort]
+   * @returns {Promise<LicensesResponse>}
+   * @see {@link https://ampache.org/api/api-json-methods#licenses}
+   */
+  licenses(params) {
+    return this.call("licenses", params);
+  },
+
+  /**
+   * This returns a single license
+   * @remarks MINIMUM_API_VERSION=420000
+   * @param {Object} params
+   * @param {import("./base.js").UID} params.filter UID to find
+   * @returns {Promise<LicenseResponse>}
+   * @see {@link https://ampache.org/api/api-json-methods#license}
+   */
+  license(params) {
+    return this.call("license", params);
+  },
+};

package/src/live-streams.js

@@ -0,0 +1,97 @@
+/**
+ * @typedef {Object} LiveStreamResponse
+ * @property {import("./base.js").UID} id
+ * @property {string} name
+ * @property {string} url
+ * @property {string} codec
+ * @property {import("./base.js").UID} catalog
+ * @property {string} site_url
+ */
+
+/**
+ * @typedef {Object} LiveStreamsResponse
+ * @property {number} total_count
+ * @property {string} md5
+ * @property {LiveStreamResponse[]} live_stream
+ */
+
+export const liveStreamsMethods = {
+  /**
+   * This returns live_streams based on the specified filter
+   * @remarks MINIMUM_API_VERSION=5.1.0
+   * @param {Object} [params]
+   * @param {string} [params.filter] Filter results to match this string
+   * @param {import("./base.js").BinaryBoolean} [params.exact] 0, 1 (if true filter is exact = rather than fuzzy LIKE)
+   * @param {Date} [params.add] ISO 8601 Date Format (2020-09-16) Find objects with an 'add' date newer than the specified date
+   * @param {Date} [params.update] ISO 8601 Date Format (2020-09-16) Find objects with an 'update' time newer than the specified date
+   * @param {number} [params.offset]
+   * @param {number} [params.limit]
+   * @param {string} [params.cond]
+   * @param {string} [params.sort]
+   * @returns {Promise<LiveStreamsResponse>}
+   * @see {@link https://ampache.org/api/api-json-methods#live_streams}
+   */
+  liveStreams(params) {
+    return this.call("live_streams", params);
+  },
+
+  /**
+   * This returns a single live_stream
+   * @remarks MINIMUM_API_VERSION=5.1.0
+   * @param {Object} params
+   * @param {import("./base.js").UID} params.filter UID to find
+   * @returns {Promise<LiveStreamResponse>}
+   * @see {@link https://ampache.org/api/api-json-methods#live_stream}
+   */
+  liveStream(params) {
+    return this.call("live_stream", params);
+  },
+
+  /**
+   * Create a live_stream (radio station) object.
+   * ACCESS REQUIRED: 50 (Content Manager)
+   * @remarks MINIMUM_API_VERSION=6.0.0
+   * @param {Object} params
+   * @param {string} params.name Stream title
+   * @param {string} params.url URL of the http/s stream
+   * @param {"mp3"|"flac"|"ogg"|"vorbis"|"opus"|"aac"|"alac"} params.codec Stream codec
+   * @param {string} params.catalog Catalog ID to associate with this stream
+   * @param {string} [params.site_url] Homepage URL of the stream
+   * @returns {Promise<LiveStreamResponse>}
+   * @see {@link https://ampache.org/api/api-json-methods#live_stream_create}
+   */
+  liveStreamCreate(params) {
+    return this.call("live_stream_create", params);
+  },
+
+  /**
+   * Edit a live_stream (radio station) object.
+   * ACCESS REQUIRED: 50 (Content Manager)
+   * @remarks MINIMUM_API_VERSION=6.0.0
+   * @param {Object} params
+   * @param {string} params.filter Object to find
+   * @param {string} [params.name] Stream title
+   * @param {string} [params.url] URL of the http/s stream
+   * @param {"mp3"|"flac"|"ogg"|"vorbis"|"opus"|"aac"|"alac"} [params.codec] Stream codec
+   * @param {string} [params.catalog] Catalog ID to associate with this stream
+   * @param {string} [params.site_url] Homepage URL of the stream
+   * @returns {Promise<LiveStreamResponse>}
+   * @see {@link https://ampache.org/api/api-json-methods#live_stream_edit}
+   */
+  liveStreamEdit(params) {
+    return this.call("live_stream_edit", params);
+  },
+
+  /**
+   * Delete a live_stream (radio station) object (if it exists)
+   * ACCESS REQUIRED: 50 (Content Manager)
+   * @remarks MINIMUM_API_VERSION=6.0.0
+   * @param {Object} params
+   * @param {string} params.filter Object to find
+   * @returns {Promise<import("./base.js").Success>}
+   * @see {@link https://ampache.org/api/api-json-methods#live_stream_delete}
+   */
+  liveStreamDelete(params) {
+    return this.call("live_stream_delete", params);
+  },
+};

package/src/playlists.js

@@ -0,0 +1,241 @@
+/**
+ * @typedef {Object} PlaylistResponse
+ * @property {import("./base.js").UID} id
+ * @property {string} name
+ * @property {string} owner
+ * @property {number} items
+ * @property {"public"|"private"} type
+ * @property {string} art
+ * @property {boolean} has_art
+ * @property {boolean} flag
+ * @property {number|null} rating
+ * @property {number|null} averagerating
+ * @property {import("./users.js").UserSummary} user
+ * @property {boolean} has_access
+ * @property {boolean} has_collaborate
+ * @property {number} last_update
+ */
+
+/**
+ * @typedef {Object} PlaylistsResponse
+ * @property {number} total_count
+ * @property {string} md5
+ * @property {PlaylistResponse[]} playlist
+ */
+
+/**
+ * @typedef {Object} HashResponse
+ * @property {string} md5
+ */
+
+export const playlistsMethods = {
+  /**
+   * This returns playlists based on the specified filter
+   * @remarks MINIMUM_API_VERSION=380001
+   * @param {Object} [params]
+   * @param {string} [params.filter] Filter results to match this string
+   * @param {import("./base.js").BinaryBoolean} [params.exact] 0, 1 (if true filter is exact = rather than fuzzy LIKE)
+   * @param {Date} [params.add] ISO 8601 Date Format (2020-09-16) Find objects with an 'add' date newer than the specified date
+   * @param {Date} [params.update] ISO 8601 Date Format (2020-09-16) Find objects with an 'update' time newer than the specified date
+   * @param {import("./base.js").BinaryBoolean} [params.hide_search] 0, 1 (if true do not include searches/smartlists in the result)
+   * @param {import("./base.js").BinaryBoolean} [params.show_dupes] 0, 1 (if true ignore 'api_hide_dupe_searches' setting)
+   * @param {import("./base.js").BinaryBoolean} [params.include] 0, 1 (if true include the objects in the playlist)
+   * @param {number} [params.offset]
+   * @param {number} [params.limit]
+   * @param {string} [params.cond]
+   * @param {string} [params.sort]
+   * @returns {Promise<PlaylistsResponse>}
+   * @see {@link https://ampache.org/api/api-json-methods#playlists}
+   */
+  playlists(params) {
+    return this.call("playlists", params);
+  },
+
+  /**
+   * This returns smartlists based on the specified filter
+   * @remarks MINIMUM_API_VERSION=380001
+   * @param {Object} [params]
+   * @param {string} [params.filter] Filter results to match this string
+   * @param {import("./base.js").BinaryBoolean} [params.exact] 0, 1 (if true filter is exact = rather than fuzzy LIKE)
+   * @param {Date} [params.add] ISO 8601 Date Format (2020-09-16) Find objects with an 'add' date newer than the specified date
+   * @param {Date} [params.update] ISO 8601 Date Format (2020-09-16) Find objects with an 'update' time newer than the specified date
+   * @param {number} [params.offset]
+   * @param {number} [params.limit]
+   * @param {string} [params.cond]
+   * @param {string} [params.sort]
+   * @returns {Promise<PlaylistsResponse>}
+   * @see {@link https://ampache.org/api/api-json-methods#smartlists}
+   */
+  smartlists(params) {
+    return this.call("smartlists", params);
+  },
+
+  /**
+   * This returns a single playlist
+   * @remarks MINIMUM_API_VERSION=380001
+   * @param {Object} params
+   * @param {import("./base.js").UID} params.filter UID to find
+   * @returns {Promise<PlaylistResponse>}
+   * @see {@link https://ampache.org/api/api-json-methods#playlist}
+   */
+  playlist(params) {
+    return this.call("playlist", params);
+  },
+
+  /**
+   * This returns a user's playlists based on the specified filter
+   * @remarks MINIMUM_API_VERSION=6.3.0
+   * @param {Object} [params]
+   * @param {string} [params.filter] Filter results to match this string
+   * @param {import("./base.js").BinaryBoolean} [params.include] 0, 1 (include playlist items)
+   * @param {import("./base.js").BinaryBoolean} [params.exact] 0, 1 (if true filter is exact = rather than fuzzy LIKE)
+   * @param {Date} [params.add] ISO 8601 Date Format (2020-09-16) Find objects with an 'add' date newer than the specified date
+   * @param {Date} [params.update] ISO 8601 Date Format (2020-09-16) Find objects with an 'update' time newer than the specified date
+   * @param {number} [params.offset]
+   * @param {number} [params.limit]
+   * @param {string} [params.cond]
+   * @param {string} [params.sort]
+   * @returns {Promise<PlaylistsResponse>}
+   * @see {@link https://ampache.org/api/api-json-methods#user_playlists}
+   */
+  userPlaylists(params) {
+    return this.call("user_playlists", params);
+  },
+
+  /**
+   * This returns a user's smartlists based on the specified filter
+   * @remarks MINIMUM_API_VERSION=6.3.0
+   * @param {Object} [params]
+   * @param {string} [params.filter] Filter results to match this string
+   * @param {import("./base.js").BinaryBoolean} [params.include] 0, 1 (include playlist items)
+   * @param {import("./base.js").BinaryBoolean} [params.exact] 0, 1 (if true filter is exact = rather than fuzzy LIKE)
+   * @param {Date} [params.add] ISO 8601 Date Format (2020-09-16) Find objects with an 'add' date newer than the specified date
+   * @param {Date} [params.update] ISO 8601 Date Format (2020-09-16) Find objects with an 'update' time newer than the specified date
+   * @param {number} [params.offset]
+   * @param {number} [params.limit]
+   * @param {string} [params.cond]
+   * @param {string} [params.sort]
+   * @returns {Promise<PlaylistsResponse>}
+   * @see {@link https://ampache.org/api/api-json-methods#user_smartlists}
+   */
+  userSmartlists(params) {
+    return this.call("user_smartlists", params);
+  },
+
+  /**
+   * This creates a new playlist and returns it
+   * @remarks MINIMUM_API_VERSION=380001
+   * @param {Object} params
+   * @param {string} params.name Playlist name
+   * @param {"public"|"private"} [params.type] public, private (Playlist type)
+   * @returns {Promise<PlaylistResponse>}
+   * @see {@link https://ampache.org/api/api-json-methods#playlist_create}
+   */
+  playlistCreate(params) {
+    return this.call("playlist_create", params);
+  },
+
+  /**
+   * This adds an item to a playlist
+   * @remarks MINIMUM_API_VERSION=6.3.0
+   * @param {Object} params
+   * @param {import("./base.js").UID} params.filter UID of Playlist
+   * @param {import("./base.js").UID} params.id UID of the object to add to playlist
+   * @param {"song"|"album"|"artist"|"playlist"} params.type 'song', 'album', 'artist', 'playlist'
+   * @returns {Promise<import("./base.js").Success>}
+   * @see {@link https://ampache.org/api/api-json-methods#playlist_add}
+   */
+  playlistAdd(params) {
+    return this.call("playlist_add", params);
+  },
+
+  /**
+   * This modifies name and type of the playlist.
+   * NOTE items and tracks must be sent together and be of equal length.
+   * @remarks MINIMUM_API_VERSION=400001
+   * @param {Object} params
+   * @param {import("./base.js").UID} params.filter UID to find
+   * @param {string} [params.name] Playlist name
+   * @param {"public"|"private"} [params.type] public, private (Playlist type)
+   * @param {string} [params.owner] Change playlist owner to the user id (-1 = System playlist)
+   * @param {string} [params.items] comma-separated song_id's (replaces existing items with a new id)
+   * @param {string} [params.tracks] comma-separated playlisttrack numbers matched to 'items' in order
+   * @returns {Promise<import("./base.js").Success>}
+   * @see {@link https://ampache.org/api/api-json-methods#playlist_edit}
+   */
+  playlistEdit(params) {
+    return this.call("playlist_edit", params);
+  },
+
+  /**
+   * This deletes a playlist
+   * @remarks MINIMUM_API_VERSION=380001
+   * @param {Object} params
+   * @param {import("./base.js").UID} params.filter UID of playlist to delete
+   * @returns {Promise<import("./base.js").Success>}
+   * @see {@link https://ampache.org/api/api-json-methods#playlist_delete}
+   */
+  playlistDelete(params) {
+    return this.call("playlist_delete", params);
+  },
+
+  /**
+   * This adds a song to a playlist
+   * @remarks MINIMUM_API_VERSION=380001; CHANGED_IN_API_VERSION=400003
+   * @param {Object} params
+   * @param {import("./base.js").UID} params.filter UID of Playlist
+   * @param {import("./base.js").UID} params.song UID of song to add to playlist
+   * @param {import("./base.js").BinaryBoolean} [params.check] 0, 1 Whether to check and ignore duplicates (default = 0)
+   * @returns {Promise<import("./base.js").Success>}
+   * @deprecated Being removed in 7.0.0. Use `playlist_add` instead.
+   * @see {@link https://ampache.org/api/api-json-methods#playlist_add_song}
+   */
+  playlistAddSong(params) {
+    return this.call("playlist_add_song", params);
+  },
+
+  /**
+   * This remove a song from a playlist
+   * @remarks MINIMUM_API_VERSION=380001; CHANGED_IN_API_VERSION=400001
+   * @param {Object} params
+   * @param {import("./base.js").UID} params.filter UID of Playlist
+   * @param {import("./base.js").UID} [params.song] UID of song to remove from playlist
+   * @param {number} [params.track] Track number to remove from playlist
+   * @returns {Promise<import("./base.js").Success>}
+   * @see {@link https://ampache.org/api/api-json-methods#playlist_remove_song}
+   */
+  playlistRemoveSong(params) {
+    return this.call("playlist_remove_song", params);
+  },
+
+  /**
+   * Get a list of song JSON, indexes or id's based on some simple search criteria
+   * @remarks MINIMUM_API_VERSION=400001; CHANGED_IN_API_VERSION=400002; 'recent' will search for tracks played after 'Popular Threshold' days; 'forgotten' will search for tracks played before 'Popular Threshold' days; 'unplayed' added in 400002 for searching unplayed tracks
+   * @param {Object} [params]
+   * @param {"recent"|"forgotten"|"unplayed"|"random"} [params.mode] (default = 'random')
+   * @param {string} [params.filter] string LIKE matched to song title
+   * @param {number} [params.album] UID of album
+   * @param {number} [params.artist] UID of artist
+   * @param {import("./base.js").BinaryBoolean} [params.flag] 0, 1 (get flagged songs only. default = 0)
+   * @param {"song"|"index"|"id"} [params.format] song, index, id (default = 'song')
+   * @param {number} [params.offset]
+   * @param {number} [params.limit]
+   * @returns {Promise<import("./songs.js").SongsResponse>}
+   * @see {@link https://ampache.org/api/api-json-methods#playlist_generate}
+   */
+  playlistGenerate(params) {
+    return this.call("playlist_generate", params);
+  },
+
+  /**
+   * This returns the md5 hash for the songs in a playlist
+   * @remarks MINIMUM_API_VERSION=6.6.0
+   * @param {Object} params
+   * @param {import("./base.js").UID} params.filter string UID of Playlist
+   * @returns {Promise<HashResponse>}
+   * @see {@link https://ampache.org/api/api-json-methods#playlist_hash}
+   */
+  playlistHash(params) {
+    return this.call("playlist_hash", params);
+  },
+};