javascript-ampache 1.1.0 → 1.1.1

package/dist/labels/index.d.ts

@@ -1,5 +1,5 @@
-import { Label } from './types';
-import { Base, BinaryBoolean, ExtendedPagination, UID } from '../base';
+import { LabelResponse, LabelsResponse } from "./types";
+import { Base, BinaryBoolean, ExtendedPagination, UID } from "../base";
 export declare class Labels extends Base {
     /**
      * This returns labels based on the specified filter
@@ -19,9 +19,7 @@ export declare class Labels extends Base {
         exact?: BinaryBoolean;
         add?: Date;
         update?: Date;
-    } & ExtendedPagination): Promise<Label[] | {
-        label: Label[];
-    }>;
+    } & ExtendedPagination): Promise<LabelsResponse>;
     /**
      * This returns a single label
      * @remarks MINIMUM_API_VERSION=420000
@@ -30,5 +28,5 @@ export declare class Labels extends Base {
      */
     label(params: {
         filter: UID;
-    }): Promise<Label>;
+    }): Promise<LabelResponse>;
 }

package/dist/labels/types.d.ts

@@ -1,5 +1,5 @@
 import { UID } from "../base";
-export type Label = {
+export type LabelResponse = {
     id: UID;
     name: string;
     artists: number;
@@ -11,3 +11,8 @@ export type Label = {
     website: string | null;
     user: UID;
 };
+export type LabelsResponse = {
+    total_count: number;
+    md5: string;
+    label: LabelResponse[];
+};

package/dist/licenses/index.d.ts

@@ -1,5 +1,5 @@
-import { License } from './types';
-import { Base, BinaryBoolean, ExtendedPagination, UID } from '../base';
+import { LicenseResponse, LicensesResponse } from "./types";
+import { Base, BinaryBoolean, ExtendedPagination, UID } from "../base";
 export declare class Licenses extends Base {
     /**
      * This returns licenses based on the specified filter
@@ -19,9 +19,7 @@ export declare class Licenses extends Base {
         exact?: BinaryBoolean;
         add?: Date;
         update?: Date;
-    } & ExtendedPagination): Promise<License[] | {
-        license: License[];
-    }>;
+    } & ExtendedPagination): Promise<LicensesResponse>;
     /**
      * This returns a single license
      * @remarks MINIMUM_API_VERSION=420000
@@ -30,5 +28,5 @@ export declare class Licenses extends Base {
      */
     license(params: {
         filter: UID;
-    }): Promise<License>;
+    }): Promise<LicenseResponse>;
 }

package/dist/licenses/types.d.ts

@@ -1,7 +1,12 @@
 import { UID } from "../base";
-export type License = {
+export type LicenseResponse = {
     id: UID;
     name: string;
     description: string;
     external_link: string;
 };
+export type LicensesResponse = {
+    total_count: number;
+    md5: string;
+    license: LicenseResponse[];
+};

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

@@ -1,5 +1,5 @@
-import { LiveStream } from './types';
-import { Base, BinaryBoolean, ExtendedPagination, Success, UID } from '../base';
+import { LiveStreamResponse, LiveStreamsResponse } from "./types";
+import { Base, BinaryBoolean, ExtendedPagination, Success, UID } from "../base";
 export declare class LiveStreams extends Base {
     /**
      * This returns live_streams based on the specified filter
@@ -19,9 +19,7 @@ export declare class LiveStreams extends Base {
         exact?: BinaryBoolean;
         add?: Date;
         update?: Date;
-    } & ExtendedPagination): Promise<LiveStream[] | {
-        live_stream: LiveStream[];
-    }>;
+    } & ExtendedPagination): Promise<LiveStreamsResponse>;
     /**
      * This returns a single live_stream
      * @remarks MINIMUM_API_VERSION=5.1.0
@@ -30,7 +28,7 @@ export declare class LiveStreams extends Base {
      */
     liveStream(params: {
         filter: UID;
-    }): Promise<LiveStream>;
+    }): Promise<LiveStreamResponse>;
     /**
      * Create a live_stream (radio station) object.
      * ACCESS REQUIRED: 50 (Content Manager)
@@ -45,10 +43,10 @@ export declare class LiveStreams extends Base {
     liveStreamCreate(params: {
         name: string;
         url: string;
-        codec: 'mp3' | 'flac' | 'ogg' | 'vorbis' | 'opus' | 'aac' | 'alac';
+        codec: "mp3" | "flac" | "ogg" | "vorbis" | "opus" | "aac" | "alac";
         catalog: string;
         site_url?: string;
-    }): Promise<LiveStream>;
+    }): Promise<LiveStreamResponse>;
     /**
      * Edit a live_stream (radio station) object.
      * ACCESS REQUIRED: 50 (Content Manager)
@@ -65,10 +63,10 @@ export declare class LiveStreams extends Base {
         filter: string;
         name?: string;
         url?: string;
-        codec?: 'mp3' | 'flac' | 'ogg' | 'vorbis' | 'opus' | 'aac' | 'alac';
+        codec?: "mp3" | "flac" | "ogg" | "vorbis" | "opus" | "aac" | "alac";
         catalog?: string;
         site_url?: string;
-    }): Promise<LiveStream>;
+    }): Promise<LiveStreamResponse>;
     /**
      * Delete a live_stream (radio station) object (if it exists)
      * ACCESS REQUIRED: 50 (Content Manager)

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

@@ -1,5 +1,5 @@
 import { UID } from "../base";
-export type LiveStream = {
+export type LiveStreamResponse = {
     id: UID;
     name: string;
     url: string;
@@ -7,3 +7,8 @@ export type LiveStream = {
     catalog: UID;
     site_url: string;
 };
+export type LiveStreamsResponse = {
+    total_count: number;
+    md5: string;
+    live_stream: LiveStreamResponse[];
+};

package/dist/playlists/index.d.ts

@@ -1,6 +1,6 @@
-import { Playlist } from './types';
-import { Song } from "../songs/types";
-import { Base, BinaryBoolean, ExtendedPagination, Pagination, Success, UID } from '../base';
+import { PlaylistResponse, PlaylistsResponse } from "./types";
+import { SongsResponse } from "../songs/types";
+import { Base, BinaryBoolean, ExtendedPagination, Pagination, Success, UID } from "../base";
 export declare class Playlists extends Base {
     /**
      * This returns playlists based on the specified filter
@@ -24,9 +24,7 @@ export declare class Playlists extends Base {
         update?: Date;
         hide_search?: BinaryBoolean;
         show_dupes?: BinaryBoolean;
-    } & ExtendedPagination): Promise<Playlist[] | {
-        playlist: Playlist[];
-    }>;
+    } & ExtendedPagination): Promise<PlaylistsResponse>;
     /**
      * This returns smartlists based on the specified filter. NOTE: Filtered from Playlists() so pagination is invalid.
      * @remarks MINIMUM_API_VERSION=380001
@@ -43,9 +41,7 @@ export declare class Playlists extends Base {
         add?: Date;
         update?: Date;
         show_dupes?: BinaryBoolean;
-    }): Promise<Playlist[] | {
-        playlist: Playlist[];
-    }>;
+    }): Promise<PlaylistsResponse>;
     /**
      * This returns a single playlist
      * @remarks MINIMUM_API_VERSION=380001
@@ -54,7 +50,7 @@ export declare class Playlists extends Base {
      */
     playlist(params: {
         filter: UID;
-    }): Promise<Playlist>;
+    }): Promise<PlaylistResponse>;
     /**
      * This returns a user's playlists based on the specified filter
      * @remarks MINIMUM_API_VERSION=6.3.0
@@ -73,9 +69,7 @@ export declare class Playlists extends Base {
         exact?: BinaryBoolean;
         add?: Date;
         update?: Date;
-    } & ExtendedPagination): Promise<Playlist[] | {
-        playlist: Playlist[];
-    }>;
+    } & ExtendedPagination): Promise<PlaylistsResponse>;
     /**
      * This returns a user's smartlists based on the specified filter
      * @remarks MINIMUM_API_VERSION=6.3.0
@@ -94,9 +88,7 @@ export declare class Playlists extends Base {
         exact?: BinaryBoolean;
         add?: Date;
         update?: Date;
-    } & ExtendedPagination): Promise<Playlist[] | {
-        playlist: Playlist[];
-    }>;
+    } & ExtendedPagination): Promise<PlaylistsResponse>;
     /**
      * This creates a new playlist and returns it
      * @remarks MINIMUM_API_VERSION=380001
@@ -106,8 +98,8 @@ export declare class Playlists extends Base {
      */
     playlistCreate(params: {
         name: string;
-        type?: 'public' | 'private';
-    }): Promise<Playlist>;
+        type?: "public" | "private";
+    }): Promise<PlaylistResponse>;
     /**
      * This adds an item to a playlist
      * @remarks MINIMUM_API_VERSION=6.3.0
@@ -119,7 +111,7 @@ export declare class Playlists extends Base {
     playlistAdd(params: {
         filter: UID;
         id: UID;
-        type: 'song' | 'album' | 'artist' | 'playlist';
+        type: "song" | "album" | "artist" | "playlist";
     }): Promise<Success>;
     /**
      * This modifies name and type of the playlist.
@@ -136,7 +128,7 @@ export declare class Playlists extends Base {
     playlistEdit(params: {
         filter: UID;
         name?: string;
-        type?: 'public' | 'private';
+        type?: "public" | "private";
         owner?: string;
         items?: string;
         tracks?: string;
@@ -191,13 +183,11 @@ export declare class Playlists extends Base {
      * @see {@link https://ampache.org/api/api-json-methods#playlist_generate}
      */
     playlistGenerate(params?: {
-        mode?: 'recent' | 'forgotten' | 'unplayed' | 'random';
+        mode?: "recent" | "forgotten" | "unplayed" | "random";
         filter?: string;
         album?: number;
         artist?: number;
         flag?: BinaryBoolean;
-        format?: 'song' | 'index' | 'id';
-    } & Pagination): Promise<Song[] | {
-        song: Song[];
-    }>;
+        format?: "song" | "index" | "id";
+    } & Pagination): Promise<SongsResponse>;
 }

package/dist/playlists/types.d.ts

@@ -1,13 +1,18 @@
 import { UID } from "../base";
-export type Playlist = {
+export type PlaylistResponse = {
     id: UID;
     name: string;
     owner: string;
     items: number;
-    type: 'public' | 'private';
+    type: "public" | "private";
     art: string;
     has_art: boolean;
     flag: boolean;
     rating: number | null;
     averagerating: number | null;
 };
+export type PlaylistsResponse = {
+    total_count: number;
+    md5: string;
+    playlist: PlaylistResponse[];
+};

package/dist/podcasts/index.d.ts

@@ -1,5 +1,5 @@
-import { Podcast, PodcastEpisode, DeletedPodcastEpisode } from './types';
-import { Base, ExtendedPagination, Pagination, Success, UID } from '../base';
+import { PodcastResponse, PodcastsResponse, PodcastEpisodeResponse, PodcastEpisodesResponse, DeletedPodcastEpisodesResponse } from "./types";
+import { Base, ExtendedPagination, Pagination, Success, UID } from "../base";
 export declare class Podcasts extends Base {
     /**
      * Get information about podcasts
@@ -14,10 +14,8 @@ export declare class Podcasts extends Base {
      */
     podcasts(params?: {
         filter?: string;
-        include?: 'episodes';
-    } & ExtendedPagination): Promise<Podcast[] | {
-        podcast: Podcast[];
-    }>;
+        include?: "episodes";
+    } & ExtendedPagination): Promise<PodcastsResponse>;
     /**
      * Get information about podcasts
      * @remarks MINIMUM_API_VERSION=420000
@@ -29,8 +27,8 @@ export declare class Podcasts extends Base {
      */
     podcast(params?: {
         filter: UID;
-        include?: 'episodes';
-    } & Pagination): Promise<Podcast>;
+        include?: "episodes";
+    } & Pagination): Promise<PodcastResponse>;
     /**
      * Create a podcast that can be used by anyone to stream media.
      * @remarks MINIMUM_API_VERSION=420000
@@ -41,7 +39,7 @@ export declare class Podcasts extends Base {
     podcastCreate(params: {
         url: string;
         catalog: UID;
-    }): Promise<Podcast>;
+    }): Promise<PodcastResponse>;
     /**
      * Update the description and/or expiration date for an existing podcast.
      * @remarks MINIMUM_API_VERSION=420000
@@ -84,9 +82,7 @@ export declare class Podcasts extends Base {
      */
     podcastEpisodes(params: {
         filter: UID;
-    } & ExtendedPagination): Promise<PodcastEpisode[] | {
-        podcast_episode: PodcastEpisode[];
-    }>;
+    } & ExtendedPagination): Promise<PodcastEpisodesResponse>;
     /**
      * Get the podcast_episode from a UID
      * @remarks MINIMUM_API_VERSION=420000
@@ -95,7 +91,7 @@ export declare class Podcasts extends Base {
      */
     podcastEpisode(params: {
         filter: UID;
-    }): Promise<PodcastEpisode>;
+    }): Promise<PodcastEpisodeResponse>;
     /**
      * Delete an existing podcast_episode
      * @remarks MINIMUM_API_VERSION=420000
@@ -121,7 +117,5 @@ export declare class Podcasts extends Base {
      * @param [params.limit]
      * @see {@link https://ampache.org/api/api-json-methods#deleted_podcast_episodes}
      */
-    deletedPodcastEpisodes(params?: {} & Pagination): Promise<DeletedPodcastEpisode[] | {
-        deleted_podcast_episode: DeletedPodcastEpisode[];
-    }>;
+    deletedPodcastEpisodes(params?: {} & Pagination): Promise<DeletedPodcastEpisodesResponse>;
 }

package/dist/podcasts/types.d.ts

@@ -1,5 +1,5 @@
 import { UID } from "../base";
-export type Podcast = {
+export type PodcastResponse = {
     id: UID;
     name: string;
     description: string;
@@ -16,9 +16,14 @@ export type Podcast = {
     flag: boolean;
     rating: number | null;
     averaterating: number | null;
-    podcast_episode: PodcastEpisode[];
+    podcast_episode: PodcastEpisodeResponse[];
 };
-export type PodcastEpisode = {
+export type PodcastsResponse = {
+    total_count: number;
+    md5: string;
+    podcast: PodcastResponse[];
+};
+export type PodcastEpisodeResponse = {
     id: UID;
     title: string;
     name: string;
@@ -28,7 +33,7 @@ export type PodcastEpisode = {
     author_full: string;
     website: string;
     pubdate: string;
-    state: 'completed' | 'pending';
+    state: "completed" | "pending";
     filelength: string;
     filesize: string;
     filename: string;
@@ -51,7 +56,12 @@ export type PodcastEpisode = {
     playcount: number;
     played: number;
 };
-export type DeletedPodcastEpisode = {
+export type PodcastEpisodesResponse = {
+    total_count: number;
+    md5: string;
+    podcast_episode: PodcastEpisodeResponse[];
+};
+export type DeletedPodcastEpisodeResponse = {
     id: UID;
     addition_time: number;
     delete_time: number;
@@ -62,3 +72,8 @@ export type DeletedPodcastEpisode = {
     total_skip: number;
     podcast: UID;
 };
+export type DeletedPodcastEpisodesResponse = {
+    total_count: number;
+    md5: string;
+    deleted_podcast_episode: DeletedPodcastEpisodeResponse[];
+};

package/dist/preferences/index.d.ts

@@ -1,5 +1,5 @@
-import { Base, BinaryBoolean, Success } from '../base';
-import { Preference } from "./types";
+import { Base, BinaryBoolean, Success } from "../base";
+import { PreferenceResponse, PreferencesResponse } from "./types";
 export declare class Preferences extends Base {
     /**
      * Get your server preferences
@@ -7,9 +7,7 @@ export declare class Preferences extends Base {
      * @remarks MINIMUM_API_VERSION=5.0.0
      * @see {@link https://ampache.org/api/api-json-methods#system_preferences}
      */
-    systemPreferences(): Promise<Preference[] | {
-        preference: Preference[];
-    }>;
+    systemPreferences(): Promise<PreferencesResponse>;
     /**
      * Get your system preference by name
      * ACCESS REQUIRED: 100 (Admin)
@@ -19,17 +17,13 @@ export declare class Preferences extends Base {
      */
     systemPreference(params: {
         filter: string;
-    }): Promise<{
-        preference: Preference;
-    }>;
+    }): Promise<PreferenceResponse>;
     /**
      * 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[];
-    }>;
+    userPreferences(): Promise<PreferencesResponse>;
     /**
      * Get your user preference by name
      * @remarks MINIMUM_API_VERSION=5.0.0
@@ -38,9 +32,7 @@ export declare class Preferences extends Base {
      */
     userPreference(params: {
         filter: string;
-    }): Promise<{
-        preference: Preference;
-    }>;
+    }): Promise<PreferenceResponse>;
     /**
      * Add a new preference to your server
      * ACCESS REQUIRED: 100 (Admin)
@@ -55,9 +47,9 @@ export declare class Preferences extends Base {
      */
     preferenceCreate(params: {
         filter: string;
-        type: 'boolean' | 'integer' | 'string' | 'special';
+        type: "boolean" | "integer" | "string" | "special";
         default: string | number;
-        category: 'interface' | 'internal' | 'options' | 'playlist' | 'plugins' | 'streaming';
+        category: "interface" | "internal" | "options" | "playlist" | "plugins" | "streaming";
         description?: string;
         subcategory?: string;
         level?: number;

package/dist/preferences/types.d.ts

@@ -1,5 +1,5 @@
 import { UID } from "../base";
-export type Preference = {
+export type PreferenceResponse = {
     id: UID;
     name: string;
     level: string;
@@ -9,3 +9,8 @@ export type Preference = {
     category: string;
     subcategory: string | null;
 };
+export type PreferencesResponse = {
+    total_count: number;
+    md5: string;
+    preference: PreferenceResponse[];
+};

package/dist/shares/index.d.ts

@@ -1,5 +1,5 @@
-import { Share } from './types';
-import { Base, BinaryBoolean, ExtendedPagination, Success, UID } from '../base';
+import { ShareResponse, SharesResponse } from "./types";
+import { Base, BinaryBoolean, ExtendedPagination, Success, UID } from "../base";
 export declare class Shares extends Base {
     /**
      * This searches the shares and returns... shares
@@ -15,9 +15,7 @@ export declare class Shares extends Base {
     shares(params?: {
         filter?: string;
         exact?: BinaryBoolean;
-    } & ExtendedPagination): Promise<Share[] | {
-        share: Share[];
-    }>;
+    } & ExtendedPagination): Promise<SharesResponse>;
     /**
      * Return a share from UID
      * @remarks MINIMUM_API_VERSION=420000
@@ -26,22 +24,22 @@ export declare class Shares extends Base {
      */
     share(params: {
         filter: UID;
-    }): Promise<Share>;
+    }): Promise<ShareResponse>;
     /**
      * 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.type ('song', 'album', 'artist', 'playlist', 'podcast', 'podcast_episode', 'video')
      * @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' | 'playlist' | 'podcast' | 'podcast_episode' | 'video';
+        type: "song" | "album" | "artist" | "playlist" | "podcast" | "podcast_episode" | "video";
         description?: string;
         expires?: number;
-    }): Promise<Share>;
+    }): Promise<ShareResponse>;
     /**
      * Update the description and/or expiration date for an existing share
      * @remarks MINIMUM_API_VERSION=420000

package/dist/shares/types.d.ts

@@ -1,5 +1,5 @@
 import { UID } from "../base";
-export type Share = {
+export type ShareResponse = {
     id: UID;
     name: string;
     owner: string;
@@ -16,3 +16,8 @@ export type Share = {
     public_url: string;
     description: string;
 };
+export type SharesResponse = {
+    total_count: number;
+    md5: string;
+    share: ShareResponse[];
+};

package/dist/shouts/index.d.ts

@@ -1,5 +1,5 @@
-import { Shout } from './types';
-import { Base } from '../base';
+import { ShoutResponse } from "./types";
+import { Base } from "../base";
 export declare class Shouts extends Base {
     /**
      * This gets the latest posted shouts
@@ -11,7 +11,7 @@ export declare class Shouts extends Base {
     last_shouts(params?: {
         username?: string;
         limit?: number;
-    }): Promise<Shout[] | {
-        shout: Shout[];
+    }): Promise<{
+        shout: ShoutResponse[];
     }>;
 }

package/dist/shouts/types.d.ts

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