javascript-ampache 0.0.1 → 1.0.1

package/dist/live-streams/index.d.ts

@@ -1,5 +1,5 @@
 import { LiveStream } from './types';
-import { Base, BinaryBoolean, Pagination, UID } from '../base';
+import { Base, BinaryBoolean, Pagination, Success, UID } from '../base';
 export declare class LiveStreams extends Base {
     /**
      * This returns live_streams based on the specified filter
@@ -29,4 +29,52 @@ export declare class LiveStreams extends Base {
     liveStream(params: {
         filter: UID;
     }): Promise<LiveStream>;
+    /**
+     * Create a live_stream (radio station) object.
+     * ACCESS REQUIRED: 50 (Content Manager)
+     * @remarks MINIMUM_API_VERSION=6.0.0
+     * @param params.name Stream title
+     * @param params.url URL of the http/s stream
+     * @param params.codec Stream codec
+     * @param params.catalog Catalog ID to associate with this stream
+     * @param [params.site_url] Homepage URL of the stream
+     * @see {@link https://ampache.org/api/api-json-methods#live_stream_create}
+     */
+    liveStreamCreate(params: {
+        name: string;
+        url: string;
+        codec: 'mp3' | 'flac' | 'ogg' | 'vorbis' | 'opus' | 'aac' | 'alac';
+        catalog: string;
+        site_url?: string;
+    }): Promise<LiveStream>;
+    /**
+     * Edit a live_stream (radio station) object.
+     * ACCESS REQUIRED: 50 (Content Manager)
+     * @remarks MINIMUM_API_VERSION=6.0.0
+     * @param params.filter Object to find
+     * @param [params.name] Stream title
+     * @param [params.url] URL of the http/s stream
+     * @param [params.codec] Stream codec
+     * @param [params.catalog] Catalog ID to associate with this stream
+     * @param [params.site_url] Homepage URL of the stream
+     * @see {@link https://ampache.org/api/api-json-methods#live_stream_edit}
+     */
+    liveStreamEdit(params: {
+        filter: string;
+        name?: string;
+        url?: string;
+        codec?: 'mp3' | 'flac' | 'ogg' | 'vorbis' | 'opus' | 'aac' | 'alac';
+        catalog?: string;
+        site_url?: string;
+    }): Promise<LiveStream>;
+    /**
+     * Delete a live_stream (radio station) object (if it exists)
+     * ACCESS REQUIRED: 50 (Content Manager)
+     * @remarks MINIMUM_API_VERSION=6.0.0
+     * @param params.filter Object to find
+     * @see {@link https://ampache.org/api/api-json-methods#live_stream_delete}
+     */
+    liveStreamDelete(params: {
+        filter: string;
+    }): Promise<Success>;
 }

package/dist/podcasts/types.d.ts

@@ -34,6 +34,11 @@ export type PodcastEpisode = {
     mime: string;
     time: number;
     size: number;
+    bitrate: number;
+    stream_bitrate: number;
+    rate: number;
+    mode: number | null;
+    channels: number | null;
     public_url: string;
     url: string;
     catalog: UID;
@@ -42,7 +47,7 @@ export type PodcastEpisode = {
     rating: number | null;
     averagerating: number | null;
     playcount: number;
-    played: string;
+    played: number;
 };
 export type DeletedPodcastEpisode = {
     id: UID;

package/dist/preferences/index.d.ts

@@ -53,7 +53,7 @@ export declare class Preferences extends Base {
         filter: string;
         type: 'boolean' | 'integer' | 'string' | 'special';
         default: string | number;
-        category: 'interface' | 'internal' | 'options' | 'playlist' | 'plugins' | 'streaming' | 'system';
+        category: 'interface' | 'internal' | 'options' | 'playlist' | 'plugins' | 'streaming';
         description?: string;
         subcategory?: string;
         level?: number;

package/dist/system/index.d.ts

@@ -1,4 +1,5 @@
 import { Base, BinaryBoolean, Pagination, Success, UID } from '../base';
+import { IndexEntry } from "./types";
 export declare class System extends Base {
     /**
      * Check Ampache for updates and run the update if there is one.
@@ -18,6 +19,7 @@ export declare class System extends Base {
      * @param [params.offset]
      * @param [params.limit]
      * @see {@link https://ampache.org/api/api-json-methods#get_indexes}
+     * @deprecated Being removed in 7.0.0. Use `list` instead.
      */
     getIndexes(params: {
         type: 'song' | 'album' | 'artist' | 'album_artist' | 'playlist' | 'podcast' | 'podcast_episode' | 'live_stream';
@@ -25,8 +27,51 @@ export declare class System extends Base {
         add?: Date;
         update?: Date;
         include?: BinaryBoolean;
-        hide_search?: number;
+        hide_search?: BinaryBoolean;
     } & Pagination): Promise<any>;
+    /**
+     * This takes a named array of objects and returning `id`, `name`, `prefix` and `basename`
+     * @remarks MINIMUM_API_VERSION=6.0.0
+     * @param params.type type of object to find
+     * @param [params.filter] Value is Alpha Match for returned results, may be more than one letter/number
+     * @param [params.add] ISO 8601 Date Format (2020-09-16) Find objects with an 'add' date newer than the specified date
+     * @param [params.update] ISO 8601 Date Format (2020-09-16) Find objects with an 'update' time newer than the specified date
+     * @param [params.hide_search] 0, 1 (if true do not include searches/smartlists in the result)
+     * @param [params.offset]
+     * @param [params.limit]
+     * @see {@link https://ampache.org/api/api-json-methods#list}
+     */
+    list(params: {
+        type: 'song' | 'album' | 'artist' | 'album_artist' | 'playlist' | 'podcast' | 'podcast_episode' | 'live_stream';
+        filter?: string;
+        add?: Date;
+        update?: Date;
+        hide_search?: BinaryBoolean;
+    } & Pagination): Promise<{
+        list: IndexEntry[];
+    }>;
+    /**
+     * Return children of a parent object in a folder traversal/browse style
+     * If you don't send any parameters you'll get a catalog list (the 'root' path)
+     * @remarks MINIMUM_API_VERSION=6.0.0
+     * @param [params.filter] object_id
+     * @param [params.type] type of object to find
+     * @param [params.catalog] catalog ID you are browsing (required on 'artist', 'album', 'podcast')
+     * @param [params.add] ISO 8601 Date Format (2020-09-16) Find objects with an 'add' date newer than the specified date
+     * @param [params.update] ISO 8601 Date Format (2020-09-16) Find objects with an 'update' time newer than the specified date
+     * @param [params.offset]
+     * @param [params.limit]
+     * @see {@link https://ampache.org/api/api-json-methods#browse}
+     */
+    browse(params: {
+        filter?: UID;
+        type?: 'root' | 'catalog' | 'artist' | 'album' | 'podcast';
+        catalog?: number;
+        add?: Date;
+        update?: Date;
+    } & Pagination): Promise<{
+        browse: IndexEntry[];
+    }>;
     /**
      * Return similar artist IDs or similar song IDs compared to the input filter
      * @remarks MINIMUM_API_VERSION=420000
@@ -200,7 +245,7 @@ export declare class System extends Base {
         id: UID;
         type: 'song' | 'podcast_episode' | 'search' | 'playlist';
         format?: string;
-    }): Promise<unknown>;
+    }): Promise<Blob>;
     /**
      * Get an art image file.
      * @remarks MINIMUM_API_VERSION=400001
@@ -260,7 +305,7 @@ export declare class System extends Base {
      */
     advancedSearch(params: {
         operator: 'and' | 'or';
-        type: 'song' | 'album' | 'artist' | 'label' | 'playlist' | 'podcast' | 'podcast_episode' | 'genre' | 'user' | 'video';
+        type: 'song' | 'album' | 'album_disk' | 'artist' | 'label' | 'playlist' | 'podcast' | 'podcast_episode' | 'genre' | 'user' | 'video';
         rules: Array<Array<string>>;
         random?: BinaryBoolean;
     } & Pagination): Promise<any>;

package/dist/system/types.d.ts

@@ -5,5 +5,12 @@ import { Playlist } from "../playlists/types";
 import { Podcast, PodcastEpisode } from "../podcasts/types";
 import { LiveStream } from "../live-streams/types";
 import { Video } from "../videos/types";
+import { UID } from "../base";
 export type IndexType = Song | Album | Artist | Playlist | Podcast | PodcastEpisode | LiveStream;
 export type StatsType = Song | Album | Artist | Video | Playlist | Podcast | PodcastEpisode;
+export type IndexEntry = {
+    id: UID;
+    name: string;
+    prefix: string;
+    basename: string;
+};

package/dist/users/index.d.ts

@@ -38,6 +38,21 @@ export declare class Users extends Base {
         disable?: BinaryBoolean;
         catalog_filter_group?: number;
     }): Promise<Success>;
+    /**
+     * Register as a new user if allowed.
+     * @remarks MINIMUM_API_VERSION=6.0.0
+     * @param params.username Username
+     * @param params.password SHA256 hashed password
+     * @param params.email  Email
+     * @param [params.fullname] Full Name
+     * @see {@link https://ampache.org/api/api-json-methods/#register}
+     */
+    register(params: {
+        username: string;
+        password: string;
+        email: string;
+        fullname?: string;
+    }): Promise<Success>;
     /**
      * Update an existing user
      * ACCESS REQUIRED: 100 (Admin)
@@ -52,6 +67,7 @@ export declare class Users extends Base {
      * @param  [params.disable] 0, 1
      * @param  [params.maxbitrate] Max bitrate for transcoding
      * @see {@link https://ampache.org/api/api-json-methods#user_update}
+     * @deprecated Being removed in 7.0.0. Use `user_edit` instead.
      */
     userUpdate(params: {
         username: string;
@@ -64,6 +80,42 @@ export declare class Users extends Base {
         disable?: BinaryBoolean;
         maxbitrate?: string;
     }): Promise<Success>;
+    /**
+     * Update an existing user
+     * ACCESS REQUIRED: 100 (Admin)
+     * @remarks MINIMUM_API_VERSION=6.0.0
+     * @param  params.username Username
+     * @param  [params.password] Password
+     * @param  [params.email] Email
+     * @param  [params.fullname] Full Name
+     * @param  [params.website] Website
+     * @param  [params.state] State
+     * @param  [params.city] City
+     * @param  [params.disable] 0, 1
+     * @param  [params.maxbitrate] Max bitrate for transcoding
+     * @param  [params.group] Catalog filter group, default = 0
+     * @param  [params.fullname_public] show fullname in public display
+     * @param  [params.reset_apikey] reset user Api Key
+     * @param  [params.reset_streamtoken] reset user Stream Token
+     * @param  [params.clear_stats] reset all stats for this user
+     * @see {@link https://ampache.org/api/api-json-methods#user_edit}
+     */
+    userEdit(params: {
+        username: string;
+        password?: string;
+        email?: string;
+        fullname?: string;
+        website?: string;
+        state?: string;
+        city?: string;
+        maxbitrate?: string;
+        group?: number;
+        disable?: BinaryBoolean;
+        fullname_public?: BinaryBoolean;
+        reset_apikey?: BinaryBoolean;
+        reset_streamtoken?: BinaryBoolean;
+        clear_stats?: BinaryBoolean;
+    }): Promise<Success>;
     /**
      * Delete an existing user.
      * ACCESS REQUIRED: 100 (Admin)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "javascript-ampache",
-  "version": "0.0.1",
+  "version": "1.0.1",
   "description": "A JS library for the Ampache API",
   "main": "dist/index.js",
   "module": "dist/index.m.js",

package/src/base.ts

@@ -58,6 +58,27 @@ export abstract class Base {
         })
     }
 
+    protected binary<T> (endpoint: string, includeAuth: boolean = true): Promise<Blob> {
+        let url = this.url + "/server/json.server.php?action=" + endpoint;
+
+        if (includeAuth) {
+            url += "&auth=" + this.sessionKey + "&version=" + this.version;
+        }
+
+        if (this.debug) {
+            console.debug(
+                "javascript-ampache query URL %c" + url,
+                "color: black; font-style: italic; background-color: orange;padding: 2px"
+            );
+        }
+
+        return fetch(url)
+            .then(response => response.blob())
+            .then(r => {
+                return r;
+            })
+    }
+
     public setSessionKey(sessionKey: string) {
         this.sessionKey = sessionKey;
     }

package/src/catalogs/index.ts

@@ -68,4 +68,48 @@ export class Catalogs extends Base {
         query += qs.stringify(params, '&');
         return this.request<Success>(query);
     }
+
+    /**
+     * Create a new catalog.
+     * ACCESS REQUIRED: 75 (Catalog Manager)
+     * @remarks MINIMUM_API_VERSION=6.0.0
+     * @param params.name Name for the catalog
+     * @param params.path URL or folder path for your catalog
+     * @param [params.type] Default: 'local'
+     * @param [params.media_type] Default: 'music'
+     * @param [params.file_pattern] Pattern used identify tags from the file name. Default: '%T - %t'
+     * @param [params.folder_pattern] Pattern used identify tags from the folder name. Default: '%a/%A'
+     * @param [params.username] login to remote catalog
+     * @param [params.password] password to remote catalog
+     * @see {@link https://ampache.org/api/api-json-methods#catalog_add}
+     */
+    catalogAdd(params: {
+        name: string,
+        path: string,
+        type?: 'local' | 'beets' | 'remote' | 'subsonic' | 'seafile' | 'beetsremote',
+        media_type?: 'music' | 'podcast' | 'clip' | 'tvshow' | 'movie' | 'personal_video',
+        file_pattern?: string,
+        folder_pattern?: string,
+        username?: string,
+        password?: string,
+    }) {
+        let query = 'catalog_add';
+        query += qs.stringify(params, '&');
+        return this.request<Catalog>(query);
+    }
+
+    /**
+     * Delete an existing catalog. (if it exists)
+     * ACCESS REQUIRED: 75 (Catalog Manager)
+     * @remarks MINIMUM_API_VERSION=6.0.0
+     * @param params.filter ID of the catalog
+     * @see {@link https://ampache.org/api/api-json-methods#catalog_delete}
+     */
+    catalogDelete(params: {
+        filter: UID,
+    }) {
+        let query = 'catalog_delete';
+        query += qs.stringify(params, '&');
+        return this.request<Success>(query);
+    }
 }

package/src/live-streams/index.ts

@@ -1,6 +1,6 @@
 import qs from 'querystringify';
 import { LiveStream } from './types';
-import { Base, BinaryBoolean, Pagination, UID } from '../base';
+import { Base, BinaryBoolean, Pagination, Success, UID } from '../base';
 
 export class LiveStreams extends Base {
     /**
@@ -39,4 +39,67 @@ export class LiveStreams extends Base {
         query += qs.stringify(params, '&');
         return this.request<LiveStream>(query);
     }
+
+    /**
+     * Create a live_stream (radio station) object.
+     * ACCESS REQUIRED: 50 (Content Manager)
+     * @remarks MINIMUM_API_VERSION=6.0.0
+     * @param params.name Stream title
+     * @param params.url URL of the http/s stream
+     * @param params.codec Stream codec
+     * @param params.catalog Catalog ID to associate with this stream
+     * @param [params.site_url] Homepage URL of the stream
+     * @see {@link https://ampache.org/api/api-json-methods#live_stream_create}
+     */
+    liveStreamCreate (params: {
+        name: string,
+        url: string,
+        codec: 'mp3' | 'flac' | 'ogg' | 'vorbis' | 'opus' | 'aac' | 'alac',
+        catalog: string,
+        site_url?: string
+    }) {
+        let query = 'live_stream_create';
+        query += qs.stringify(params, '&');
+        return this.request<LiveStream>(query);
+    }
+
+    /**
+     * Edit a live_stream (radio station) object.
+     * ACCESS REQUIRED: 50 (Content Manager)
+     * @remarks MINIMUM_API_VERSION=6.0.0
+     * @param params.filter Object to find
+     * @param [params.name] Stream title
+     * @param [params.url] URL of the http/s stream
+     * @param [params.codec] Stream codec
+     * @param [params.catalog] Catalog ID to associate with this stream
+     * @param [params.site_url] Homepage URL of the stream
+     * @see {@link https://ampache.org/api/api-json-methods#live_stream_edit}
+     */
+    liveStreamEdit (params: {
+        filter: string,
+        name?: string,
+        url?: string,
+        codec?: 'mp3' | 'flac' | 'ogg' | 'vorbis' | 'opus' | 'aac' | 'alac',
+        catalog?: string,
+        site_url?: string
+    }) {
+        let query = 'live_stream_edit';
+        query += qs.stringify(params, '&');
+        return this.request<LiveStream>(query);
+    }
+
+    /**
+     * Delete a live_stream (radio station) object (if it exists)
+     * ACCESS REQUIRED: 50 (Content Manager)
+     * @remarks MINIMUM_API_VERSION=6.0.0
+     * @param params.filter Object to find
+     * @see {@link https://ampache.org/api/api-json-methods#live_stream_delete}
+     */
+    liveStreamDelete (params: {
+        filter: string,
+    }) {
+        let query = 'live_stream_delete';
+        query += qs.stringify(params, '&');
+        return this.request<Success>(query);
+    }
 }

package/src/podcasts/types.ts

@@ -36,6 +36,11 @@ export type PodcastEpisode = {
     mime: string,
     time: number,
     size: number,
+    bitrate: number,
+    stream_bitrate: number,
+    rate: number,
+    mode: number | null,
+    channels: number | null,
     public_url: string,
     url: string,
     catalog: UID,
@@ -44,7 +49,7 @@ export type PodcastEpisode = {
     rating: number | null,
     averagerating: number | null,
     playcount: number,
-    played: string,
+    played: number,
 }
 
 export type DeletedPodcastEpisode = {

package/src/preferences/index.ts

@@ -73,7 +73,7 @@ export class Preferences extends Base {
         filter: string,
         type: 'boolean' | 'integer' | 'string' | 'special',
         default: string | number,
-        category: 'interface' | 'internal' | 'options' | 'playlist' | 'plugins' | 'streaming' | 'system',
+        category: 'interface' | 'internal' | 'options' | 'playlist' | 'plugins' | 'streaming',
         description?: string,
         subcategory?: string,
         level?: number,

package/src/system/index.ts

@@ -10,6 +10,7 @@ import { LiveStream } from "../live-streams/types";
 import { Label } from "../labels/types";
 import { Genre } from "../genres/types";
 import { User } from "../users/types";
+import { IndexEntry } from "./types";
 
 export class System extends Base {
     /**
@@ -34,6 +35,7 @@ export class System extends Base {
      * @param [params.offset]
      * @param [params.limit]
      * @see {@link https://ampache.org/api/api-json-methods#get_indexes}
+     * @deprecated Being removed in 7.0.0. Use `list` instead.
      */
     async getIndexes (params: {
         type: 'song' | 'album' | 'artist' | 'album_artist' | 'playlist' | 'podcast' | 'podcast_episode' | 'live_stream',
@@ -41,7 +43,7 @@ export class System extends Base {
         add?: Date,
         update?: Date,
         include?: BinaryBoolean,
-        hide_search?: number
+        hide_search?: BinaryBoolean
     } & Pagination) {
         let query = 'get_indexes';
         query += qs.stringify(params, '&');
@@ -75,6 +77,55 @@ export class System extends Base {
         }
     }
 
+    /**
+     * This takes a named array of objects and returning `id`, `name`, `prefix` and `basename`
+     * @remarks MINIMUM_API_VERSION=6.0.0
+     * @param params.type type of object to find
+     * @param [params.filter] Value is Alpha Match for returned results, may be more than one letter/number
+     * @param [params.add] ISO 8601 Date Format (2020-09-16) Find objects with an 'add' date newer than the specified date
+     * @param [params.update] ISO 8601 Date Format (2020-09-16) Find objects with an 'update' time newer than the specified date
+     * @param [params.hide_search] 0, 1 (if true do not include searches/smartlists in the result)
+     * @param [params.offset]
+     * @param [params.limit]
+     * @see {@link https://ampache.org/api/api-json-methods#list}
+     */
+    async list (params: {
+        type: 'song' | 'album' | 'artist' | 'album_artist' | 'playlist' | 'podcast' | 'podcast_episode' | 'live_stream',
+        filter?: string,
+        add?: Date,
+        update?: Date,
+        hide_search?: BinaryBoolean
+    } & Pagination) {
+        let query = 'list';
+        query += qs.stringify(params, '&');
+        return this.request<{list: IndexEntry[]}>(query);
+    }
+
+    /**
+     * Return children of a parent object in a folder traversal/browse style
+     * If you don't send any parameters you'll get a catalog list (the 'root' path)
+     * @remarks MINIMUM_API_VERSION=6.0.0
+     * @param [params.filter] object_id
+     * @param [params.type] type of object to find
+     * @param [params.catalog] catalog ID you are browsing (required on 'artist', 'album', 'podcast')
+     * @param [params.add] ISO 8601 Date Format (2020-09-16) Find objects with an 'add' date newer than the specified date
+     * @param [params.update] ISO 8601 Date Format (2020-09-16) Find objects with an 'update' time newer than the specified date
+     * @param [params.offset]
+     * @param [params.limit]
+     * @see {@link https://ampache.org/api/api-json-methods#browse}
+     */
+    async browse (params: {
+        filter?: UID,
+        type?: 'root' | 'catalog' | 'artist' | 'album' | 'podcast',
+        catalog?: number,
+        add?: Date,
+        update?: Date,
+    } & Pagination) {
+        let query = 'browse';
+        query += qs.stringify(params, '&');
+        return this.request<{browse: IndexEntry[]}>(query);
+    }
+
     /**
      * Return similar artist IDs or similar song IDs compared to the input filter
      * @remarks MINIMUM_API_VERSION=420000
@@ -319,7 +370,7 @@ export class System extends Base {
     }) {
         let query = 'stream';
         query += qs.stringify(params, '&');
-        return this.request(query);
+        return this.binary(query);
     }
 
     /**
@@ -338,7 +389,7 @@ export class System extends Base {
     }) {
         let query = 'download';
         query += qs.stringify(params, '&');
-        return this.request(query);
+        return this.binary(query);
     }
 
     /**
@@ -354,7 +405,7 @@ export class System extends Base {
     }) {
         let query = 'get_art';
         query += qs.stringify(params, '&');
-        return this.request(query);
+        return this.binary(query);
     }
 
     /**
@@ -419,7 +470,7 @@ export class System extends Base {
      */
     async advancedSearch (params: {
         operator: 'and' | 'or',
-        type: 'song' | 'album' | 'artist' | 'label' | 'playlist' | 'podcast' | 'podcast_episode' | 'genre' | 'user' | 'video',
+        type: 'song' | 'album' | 'album_disk' | 'artist' | 'label' | 'playlist' | 'podcast' | 'podcast_episode' | 'genre' | 'user' | 'video',
         rules: Array<Array<string>>,
         random?: BinaryBoolean,
     } & Pagination) {

package/src/system/types.ts

@@ -5,7 +5,15 @@ import { Playlist } from "../playlists/types";
 import { Podcast, PodcastEpisode } from "../podcasts/types";
 import { LiveStream } from "../live-streams/types";
 import { Video } from "../videos/types";
+import { UID } from "../base";
 
 export type IndexType = Song | Album | Artist | Playlist | Podcast | PodcastEpisode | LiveStream;
 
-export type StatsType = Song | Album | Artist | Video | Playlist | Podcast | PodcastEpisode;
+export type StatsType = Song | Album | Artist | Video | Playlist | Podcast | PodcastEpisode;
+
+export type IndexEntry = {
+    id: UID,
+    name: string,
+    prefix: string,
+    basename: string,
+}

package/src/users/index.ts

@@ -53,6 +53,26 @@ export class Users extends Base {
         return this.request<Success>(query);
     }
 
+    /**
+     * Register as a new user if allowed.
+     * @remarks MINIMUM_API_VERSION=6.0.0
+     * @param params.username Username
+     * @param params.password SHA256 hashed password
+     * @param params.email  Email
+     * @param [params.fullname] Full Name
+     * @see {@link https://ampache.org/api/api-json-methods/#register}
+     */
+    register (params: {
+        username: string,
+        password: string,
+        email: string,
+        fullname?: string
+    }) {
+        let query = 'register';
+        query += qs.stringify(params, '&');
+        return this.request<Success>(query);
+    }
+
     /**
      * Update an existing user
      * ACCESS REQUIRED: 100 (Admin)
@@ -67,6 +87,7 @@ export class Users extends Base {
      * @param  [params.disable] 0, 1
      * @param  [params.maxbitrate] Max bitrate for transcoding
      * @see {@link https://ampache.org/api/api-json-methods#user_update}
+     * @deprecated Being removed in 7.0.0. Use `user_edit` instead.
      */
     userUpdate (params: {
         username: string,
@@ -84,6 +105,47 @@ export class Users extends Base {
         return this.request<Success>(query);
     }
 
+    /**
+     * Update an existing user
+     * ACCESS REQUIRED: 100 (Admin)
+     * @remarks MINIMUM_API_VERSION=6.0.0
+     * @param  params.username Username
+     * @param  [params.password] Password
+     * @param  [params.email] Email
+     * @param  [params.fullname] Full Name
+     * @param  [params.website] Website
+     * @param  [params.state] State
+     * @param  [params.city] City
+     * @param  [params.disable] 0, 1
+     * @param  [params.maxbitrate] Max bitrate for transcoding
+     * @param  [params.group] Catalog filter group, default = 0
+     * @param  [params.fullname_public] show fullname in public display
+     * @param  [params.reset_apikey] reset user Api Key
+     * @param  [params.reset_streamtoken] reset user Stream Token
+     * @param  [params.clear_stats] reset all stats for this user
+     * @see {@link https://ampache.org/api/api-json-methods#user_edit}
+     */
+    userEdit (params: {
+        username: string,
+        password?: string,
+        email?: string,
+        fullname?: string,
+        website?: string,
+        state?: string,
+        city?: string,
+        maxbitrate?: string,
+        group?: number,
+        disable?: BinaryBoolean,
+        fullname_public?: BinaryBoolean,
+        reset_apikey?: BinaryBoolean,
+        reset_streamtoken?: BinaryBoolean,
+        clear_stats?: BinaryBoolean,
+    }) {
+        let query = 'user_edit';
+        query += qs.stringify(params, '&');
+        return this.request<Success>(query);
+    }
+
     /**
      * Delete an existing user.
      * ACCESS REQUIRED: 100 (Admin)