javascript-ampache 0.0.1

package/dist/playlists/types.d.ts

@@ -0,0 +1,12 @@
+import { UID } from "../base";
+export type Playlist = {
+    id: UID;
+    name: string;
+    owner: string;
+    items: number;
+    type: 'public' | 'private';
+    art: string;
+    flag: boolean;
+    rating: number | null;
+    averagerating: number | null;
+};

package/dist/podcasts/index.d.ts

@@ -0,0 +1,125 @@
+import { Podcast, PodcastEpisode, DeletedPodcastEpisode } from './types';
+import { Base, Pagination, Success, UID } from '../base';
+export declare class Podcasts extends Base {
+    /**
+     * Get information about podcasts
+     * @remarks MINIMUM_API_VERSION=420000
+     * @param [params.filter] Value is Alpha Match for returned results, may be more than one letter/number
+     * @param [params.include] episodes (include podcast_episodes in the response)
+     * @param [params.offset]
+     * @param [params.limit]
+     * @see {@link https://ampache.org/api/api-json-methods#podcasts}
+     */
+    podcasts(params?: {
+        filter?: string;
+        include?: 'episodes';
+    } & Pagination): Promise<Podcast[] | {
+        podcast: Podcast[];
+    }>;
+    /**
+     * Get information about podcasts
+     * @remarks MINIMUM_API_VERSION=420000
+     * @param params.filter UID to find
+     * @param [params.include] episodes (include podcast_episodes in the response)
+     * @param [params.offset]
+     * @param [params.limit]
+     * @see {@link https://ampache.org/api/api-json-methods#podcast}
+     */
+    podcast(params?: {
+        filter: UID;
+        include?: 'episodes';
+    } & Pagination): Promise<Podcast[] | {
+        podcast: Podcast[];
+    }>;
+    /**
+     * Create a podcast that can be used by anyone to stream media.
+     * @remarks MINIMUM_API_VERSION=420000
+     * @param params.url RSS url for podcast
+     * @param params.catalog UID of podcast catalog
+     * @see {@link https://ampache.org/api/api-json-methods#podcast_create}
+     */
+    podcastCreate(params: {
+        url: string;
+        catalog: UID;
+    }): Promise<Podcast>;
+    /**
+     * Update the description and/or expiration date for an existing podcast.
+     * @remarks MINIMUM_API_VERSION=420000
+     * @param params.filter UID to find
+     * @param [params.feed] RSS url for podcast
+     * @param [params.title] Podcast title
+     * @param [params.website] Source website URL
+     * @param [params.description] Podcast description
+     * @param [params.generator] Podcast generator
+     * @param [params.copyright] Podcast copyright
+     * @see {@link https://ampache.org/api/api-json-methods#podcast_edit}
+     */
+    podcastEdit(params: {
+        filter: UID;
+        feed?: string;
+        title?: string;
+        website?: string;
+        description?: string;
+        generator?: string;
+        copyright?: string;
+    }): Promise<Success>;
+    /**
+     * Delete an existing podcast
+     * @remarks MINIMUM_API_VERSION=420000
+     * @param params.filter UID of podcast to delete
+     * @see {@link https://ampache.org/api/api-json-methods#podcast_delete}
+     */
+    podcastDelete(params: {
+        filter: UID;
+    }): Promise<Success>;
+    /**
+     * This returns the episodes for a podcast
+     * @remarks MINIMUM_API_VERSION=420000
+     * @param params.filter UID of podcast
+     * @param [params.offset]
+     * @param [params.limit]
+     * @see {@link https://ampache.org/api/api-json-methods#podcast_episodes}
+     */
+    podcastEpisodes(params: {
+        filter: UID;
+    } & Pagination): Promise<PodcastEpisode[] | {
+        podcast_episode: PodcastEpisode[];
+    }>;
+    /**
+     * Get the podcast_episode from a UID
+     * @remarks MINIMUM_API_VERSION=420000
+     * @param params.filter UID of podcast
+     * @see {@link https://ampache.org/api/api-json-methods#podcast_episode}
+     */
+    podcastEpisode(params: {
+        filter: UID;
+    }): Promise<PodcastEpisode>;
+    /**
+     * Delete an existing podcast_episode
+     * @remarks MINIMUM_API_VERSION=420000
+     * @param params.filter UID of podcast episode to delete
+     * @see {@link https://ampache.org/api/api-json-methods#podcast_episode_delete}
+     */
+    podcastEpisodeDelete(params: {
+        filter: UID;
+    }): Promise<Success>;
+    /**
+     * Sync and download new podcast episodes
+     * ACCESS REQUIRED: 50 (Content Manager)
+     * @remarks MINIMUM_API_VERSION=420000
+     * @param params.id UID of podcast
+     * @see {@link https://ampache.org/api/api-json-methods#update_podcast}
+     */
+    updatePodcast(params: {
+        id: UID;
+    }): Promise<Success>;
+    /**
+     * This returns the episodes for a podcast that have been deleted
+     * @param [params.offset]
+     * @param [params.limit]
+     * @see {@link https://ampache.org/api/api-json-methods#deleted_podcast_episodes}
+     */
+    deletedPodcastEpisodes(params?: {} & Pagination): Promise<DeletedPodcastEpisode[] | {
+        deleted_podcast_episode: DeletedPodcastEpisode[];
+    }>;
+}

package/dist/podcasts/types.d.ts

@@ -0,0 +1,57 @@
+import { UID } from "../base";
+export type Podcast = {
+    id: UID;
+    name: string;
+    description: string;
+    language: string;
+    copyright: string;
+    feed_url: string;
+    generator: string;
+    website: string;
+    build_date: string;
+    sync_date: string;
+    public_url: string;
+    art: string;
+    flag: boolean;
+    rating: number | null;
+    averaterating: number | null;
+    podcast_episode: PodcastEpisode[];
+};
+export type PodcastEpisode = {
+    id: UID;
+    title: string;
+    name: string;
+    description: string;
+    category: string;
+    author: string;
+    author_full: string;
+    website: string;
+    pubdate: string;
+    state: 'completed' | 'pending';
+    filelength: string;
+    filesize: string;
+    filename: string;
+    mime: string;
+    time: number;
+    size: number;
+    public_url: string;
+    url: string;
+    catalog: UID;
+    art: string;
+    flag: boolean;
+    rating: number | null;
+    averagerating: number | null;
+    playcount: number;
+    played: string;
+};
+export type DeletedPodcastEpisode = {
+    id: UID;
+    addition_time: number;
+    delete_time: number;
+    title: string;
+    file: string;
+    catalog: UID;
+    total_count: number;
+    total_skip: number;
+    podcast: UID;
+};

package/dist/preferences/index.d.ts

@@ -0,0 +1,84 @@
+import { Base, BinaryBoolean, Success } from '../base';
+import { Preference } from "./types";
+export declare class Preferences extends Base {
+    /**
+     * Get your server preferences
+     * ACCESS REQUIRED: 100 (Admin)
+     * @remarks MINIMUM_API_VERSION=5.0.0
+     * @see {@link https://ampache.org/api/api-json-methods#system_preferences}
+     */
+    systemPreferences(): Promise<Preference[] | {
+        preference: Preference[];
+    }>;
+    /**
+     * Get your system preference by name
+     * ACCESS REQUIRED: 100 (Admin)
+     * @remarks MINIMUM_API_VERSION=5.0.0
+     * @param params.systemPreference Preference name e.g ('notify_email', 'ajax_load')
+     * @see {@link https://ampache.org/api/api-json-methods#system_preference}
+     */
+    systemPreference(params: {
+        filter: string;
+    }): Promise<any>;
+    /**
+     * Get your user preferences
+     * @remarks MINIMUM_API_VERSION=5.0.0
+     * @see {@link https://ampache.org/api/api-json-methods#user_preferences}
+     */
+    userPreferences(): Promise<Preference[] | {
+        preference: Preference[];
+    }>;
+    /**
+     * Get your user preference by name
+     * @remarks MINIMUM_API_VERSION=5.0.0
+     * @param params.filter Preference name e.g ('notify_email', 'ajax_load')
+     * @see {@link https://ampache.org/api/api-json-methods#user_preference}
+     */
+    userPreference(params: {
+        filter: string;
+    }): Promise<any>;
+    /**
+     * Add a new preference to your server
+     * ACCESS REQUIRED: 100 (Admin)
+     * @param params.filter Preference name e.g ('notify_email', 'ajax_load')
+     * @param params.type boolean, integer, string, special
+     * @param params.default string or integer default value
+     * @param params.category Category type
+     * @param [params.description]
+     * @param [params.subcategory]
+     * @param [params.level] access level required to change the value (default 100)
+     * @see {@link https://ampache.org/api/api-json-methods#preference_create}
+     */
+    preferenceCreate(params: {
+        filter: string;
+        type: 'boolean' | 'integer' | 'string' | 'special';
+        default: string | number;
+        category: 'interface' | 'internal' | 'options' | 'playlist' | 'plugins' | 'streaming' | 'system';
+        description?: string;
+        subcategory?: string;
+        level?: number;
+    }): Promise<Success>;
+    /**
+     * Edit a preference value and apply to all users if allowed
+     * ACCESS REQUIRED: 100 (Admin)
+     * @remarks MINIMUM_API_VERSION=5.0.0
+     * @param params.filter Preference name e.g ('notify_email', 'ajax_load')
+     * @param params.value (string/integer) Preference value
+     * @param [params.all] 0, 1 apply to all users
+     * @see {@link https://ampache.org/api/api-json-methods#preference_edit}
+     */
+    preferenceEdit(params: {
+        filter: string;
+        value: string | number;
+        all?: BinaryBoolean;
+    }): Promise<Success>;
+    /**
+     * Delete a non-system preference by name
+     * ACCESS REQUIRED: 100 (Admin)
+     * @param params.filter Preference name e.g ('notify_email', 'ajax_load')
+     * @see {@link https://ampache.org/api/api-json-methods#preference_delete}
+     */
+    preferenceDelete(params: {
+        filter: string;
+    }): Promise<Success>;
+}

package/dist/preferences/types.d.ts

@@ -0,0 +1,11 @@
+import { UID } from "../base";
+export type Preference = {
+    id: UID;
+    name: string;
+    level: string;
+    description: string;
+    value: string;
+    type: string;
+    category: string;
+    subcategory: string | null;
+};

package/dist/shares/index.d.ts

@@ -0,0 +1,69 @@
+import { Share } from './types';
+import { Base, BinaryBoolean, Pagination, Success, UID } from '../base';
+export declare class Shares extends Base {
+    /**
+     * This searches the shares and returns... shares
+     * @remarks MINIMUM_API_VERSION=420000
+     * @param [params.filter] UID to find
+     * @param [params.exact] 0, 1 boolean to match the exact filter string
+     * @param [params.offset]
+     * @param [params.limit]
+     * @see {@link https://ampache.org/api/api-json-methods#shares}
+     */
+    shares(params?: {
+        filter?: string;
+        exact?: BinaryBoolean;
+    } & Pagination): Promise<Share[] | {
+        share: Share[];
+    }>;
+    /**
+     * Return a share from UID
+     * @remarks MINIMUM_API_VERSION=420000
+     * @param params.filter UID to find
+     * @see {@link https://ampache.org/api/api-json-methods#share}
+     */
+    share(params: {
+        filter: UID;
+    }): Promise<Share>;
+    /**
+     * Create a public url that can be used by anyone to stream media.
+     * @remarks MINIMUM_API_VERSION=420000
+     * @param params.filter UID of object you are sharing
+     * @param params.type ('song', 'album', 'artist')
+     * @param [params.description] description (will be filled for you if empty)
+     * @param [params.expires] days to keep active
+     * @see {@link https://ampache.org/api/api-json-methods#share_create}
+     */
+    shareCreate(params: {
+        filter: UID;
+        type: 'song' | 'album' | 'artist';
+        description?: string;
+        expires?: number;
+    }): Promise<Share>;
+    /**
+     * Update the description and/or expiration date for an existing share
+     * @remarks MINIMUM_API_VERSION=420000
+     * @param params.filter UID to find
+     * @param [params.stream] 0, 1
+     * @param [params.download] 0, 1
+     * @param [params.expires] days to keep active
+     * @param [params.description] description
+     * @see {@link https://ampache.org/api/api-json-methods#share_edit}
+     */
+    shareEdit(params: {
+        filter: UID;
+        stream?: BinaryBoolean;
+        download?: BinaryBoolean;
+        expires?: number;
+        description?: string;
+    }): Promise<Success>;
+    /**
+     * Delete an existing share.
+     * @remarks MINIMUM_API_VERSION=420000
+     * @param params.filter UID of share to delete
+     * @see {@link https://ampache.org/api/api-json-methods#share_delete}
+     */
+    shareDelete(params: {
+        filter: UID;
+    }): Promise<Success>;
+}

package/dist/shares/types.d.ts

@@ -0,0 +1,18 @@
+import { UID } from "../base";
+export type Share = {
+    id: UID;
+    name: string;
+    owner: string;
+    allow_stream: boolean;
+    allow_download: boolean;
+    creation_date: number;
+    lastvisit_date: number;
+    object_type: string;
+    object_id: UID;
+    expire_days: number;
+    max_counter: number;
+    counter: number;
+    secret: string;
+    public_url: string;
+    description: string;
+};

package/dist/shouts/index.d.ts

@@ -0,0 +1,17 @@
+import { Shout } from './types';
+import { Base } from '../base';
+export declare class Shouts extends Base {
+    /**
+     * This gets the latest posted shouts
+     * @remarks MINIMUM_API_VERSION=380001
+     * @param [params.username] Username to find
+     * @param [params.limit] Maximum number of results to return
+     * @see {@link https://ampache.org/api/api-json-methods#last_shouts}
+     */
+    last_shouts(params?: {
+        username?: string;
+        limit?: number;
+    }): Promise<Shout[] | {
+        shout: Shout[];
+    }>;
+}

package/dist/shouts/types.d.ts

@@ -0,0 +1,8 @@
+import { UID } from "../base";
+import { UserSummary } from "../users/types";
+export type Shout = {
+    id: UID;
+    date: number;
+    text: string;
+    user: UserSummary;
+};

package/dist/songs/index.d.ts

@@ -0,0 +1,140 @@
+import { Song, DeletedSong } from './types';
+import { Base, BinaryBoolean, Pagination, Success, UID } from '../base';
+export declare class Songs extends Base {
+    /**
+     * Returns songs based on the specified filter
+     * @remarks MINIMUM_API_VERSION=380001
+     * @param [params.filter] Filter results to match this string
+     * @param [params.exact] 0, 1 (if true filter is exact = rather than fuzzy LIKE)
+     * @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#songs}
+     */
+    songs(params?: {
+        filter?: string;
+        exact?: BinaryBoolean;
+        add?: Date;
+        update?: Date;
+    } & Pagination): Promise<Song[] | {
+        song: Song[];
+    }>;
+    /**
+     * Returns a single song
+     * @remarks MINIMUM_API_VERSION=380001
+     * @param params.filter UID to find
+     * @see {@link https://ampache.org/api/api-json-methods#song}
+     */
+    song(params: {
+        filter: UID;
+    }): Promise<Song>;
+    /**
+     * Songs of the specified artist
+     * @remarks MINIMUM_API_VERSION=380001
+     * @param params.filter UID to find
+     * @param [params.top50] 0, 1 (if true filter to the artist top 50)
+     * @param [params.offset]
+     * @param [params.limit]
+     * @see {@link https://ampache.org/api/api-json-methods#artist_songs}
+     */
+    artistSongs(params: {
+        filter: UID;
+        top50?: BinaryBoolean;
+    } & Pagination): Promise<Song[] | {
+        song: Song[];
+    }>;
+    /**
+     * Songs of the specified album
+     * @remarks MINIMUM_API_VERSION=380001
+     * @param params.filter UID to find
+     * @param [params.offset]
+     * @param [params.limit]
+     * @see {@link https://ampache.org/api/api-json-methods#album_songs}
+     */
+    albumSongs(params: {
+        filter: UID;
+    } & Pagination): Promise<Song[] | {
+        song: Song[];
+    }>;
+    /**
+     * Songs of the specified genre
+     * @remarks MINIMUM_API_VERSION=380001
+     * @param params.filter UID to find
+     * @param [params.offset]
+     * @param [params.limit]
+     * @see {@link https://ampache.org/api/api-json-methods#genre_songs}
+     */
+    genreSongs(params: {
+        filter: UID;
+    } & Pagination): Promise<Song[] | {
+        song: Song[];
+    }>;
+    /**
+     * This returns the songs for a playlist
+     * @remarks MINIMUM_API_VERSION=380001
+     * @param params.filter UID to find
+     * @param [params.offset]
+     * @param [params.limit]
+     * @see {@link https://ampache.org/api/api-json-methods#playlist_songs}
+     */
+    playlistSongs(params: {
+        filter: UID;
+    } & Pagination): Promise<Song[] | {
+        song: Song[];
+    }>;
+    /**
+     * This returns the songs for a license
+     * @remarks MINIMUM_API_VERSION=420000
+     * @param params.filter UID to find
+     * @param [params.offset]
+     * @param [params.limit]
+     * @see {@link https://ampache.org/api/api-json-methods#license_songs}
+     */
+    licenseSongs(params: {
+        filter: UID;
+    } & Pagination): Promise<Song[] | {
+        song: Song[];
+    }>;
+    /**
+     * Delete an existing song. (if you are allowed to)
+     * @remarks MINIMUM_API_VERSION=5.0.0
+     * @param params.filter UID of song to delete
+     * @see {@link https://ampache.org/api/api-json-methods#song_delete}
+     */
+    songDelete(params: {
+        filter: UID;
+    }): Promise<Success>;
+    /**
+     * This takes a URL and returns the song object in question
+     * @remarks MINIMUM_API_VERSION=380001
+     * @param params.url Full Ampache URL from server
+     * @see {@link https://ampache.org/api/api-json-methods#url_to_song}
+     */
+    urlToSong(params: {
+        url: string;
+    }): Promise<Song>;
+    /**
+     * This searches the songs and returns... songs
+     * @remarks MINIMUM_API_VERSION=380001
+     * @param params.filter Filter results to match this string
+     * @param [params.offset]
+     * @param [params.limit]
+     * @see {@link https://ampache.org/api/api-json-methods#search_songs}
+     */
+    searchSongs(params: {
+        filter: string;
+    } & Pagination): Promise<Song[] | {
+        song: Song[];
+    }>;
+    /**
+     * Returns songs that have been deleted from the server
+     * @remarks MINIMUM_API_VERSION=500000
+     * @param [params.offset]
+     * @param [params.limit]
+     * @see {@link https://ampache.org/api/api-json-methods#deleted_songs}
+     */
+    deletedSongs(params?: {} & Pagination): Promise<DeletedSong[] | {
+        deleted_song: DeletedSong[];
+    }>;
+}

package/dist/songs/types.d.ts

@@ -0,0 +1,62 @@
+import { ArtistSummary } from "../artists/types";
+import { GenreSummary } from "../genres/types";
+import { UID } from "../base";
+import { AlbumSummary } from "../albums/types";
+export type Song = {
+    id: UID;
+    title: string;
+    name: string;
+    artist: ArtistSummary;
+    album: AlbumSummary;
+    albumartist: ArtistSummary;
+    disk: number;
+    track: number;
+    filename: string;
+    genre: GenreSummary[];
+    playlisttrack: number;
+    time: number;
+    year: number | string;
+    format: string;
+    stream_format: string;
+    rate: number;
+    mode: string;
+    mime: string;
+    stream_mime: string;
+    url: string;
+    size: number;
+    mbid: string | null;
+    album_mbid: string | null;
+    artist_mbid: string | null;
+    art: string;
+    flag: boolean;
+    rating: number | null;
+    averagerating: number | null;
+    playcount: number;
+    catalog: number;
+    composer: string;
+    channels: number | null;
+    comment: string;
+    license: string | null;
+    publisher: string;
+    language: string;
+    lyrics: string;
+    replaygain_album_gain: number | null;
+    replaygain_album_peak: number | null;
+    replaygain_track_gain: number | null;
+    replaygain_track_peak: number | null;
+    r128_album_gain: number | null;
+    r128_track_gain: number | null;
+};
+export type DeletedSong = {
+    id: UID;
+    addition_time: number;
+    delete_time: number;
+    update_time: number;
+    title: string;
+    file: string;
+    catalog: UID;
+    total_count: number;
+    total_skip: number;
+    album: UID;
+    artist: UID;
+};