javascript-ampache 1.0.6 → 1.0.8

package/src/licenses/index.ts

@@ -1,6 +1,6 @@
 import qs from 'querystringify';
 import { License } from './types';
-import { Base, BinaryBoolean, Pagination, UID } from '../base';
+import { Base, BinaryBoolean, ExtendedPagination, UID } from '../base';
 
 export class Licenses extends Base {
     /**
@@ -12,6 +12,8 @@ export class Licenses extends Base {
      * @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]
+     * @param [params.cond]
+     * @param [params.sort]
      * @see {@link https://ampache.org/api/api-json-methods#licenses}
      */
     async licenses (params?: {
@@ -19,7 +21,7 @@ export class Licenses extends Base {
         exact?: BinaryBoolean,
         add?: Date,
         update?: Date,
-    } & Pagination) {
+    } & ExtendedPagination) {
         let query = 'licenses';
         query += qs.stringify(params, '&');
         let data = await this.request<{license: License[]}>(query);

package/src/live-streams/index.ts

@@ -1,6 +1,6 @@
 import qs from 'querystringify';
 import { LiveStream } from './types';
-import { Base, BinaryBoolean, Pagination, Success, UID } from '../base';
+import { Base, BinaryBoolean, ExtendedPagination, Success, UID } from '../base';
 
 export class LiveStreams extends Base {
     /**
@@ -12,6 +12,8 @@ export class LiveStreams extends Base {
      * @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]
+     * @param [params.cond]
+     * @param [params.sort]
      * @see {@link https://ampache.org/api/api-json-methods#live_streams}
      */
     async liveStreams (params?: {
@@ -19,7 +21,7 @@ export class LiveStreams extends Base {
         exact?: BinaryBoolean,
         add?: Date,
         update?: Date,
-    } & Pagination) {
+    } & ExtendedPagination) {
         let query = 'live_streams';
         query += qs.stringify(params, '&');
         let data = await this.request<{live_stream: LiveStream[]}>(query);

package/src/playlists/index.ts

@@ -1,7 +1,7 @@
 import qs from 'querystringify';
 import { Playlist } from './types';
 import { Song } from "../songs/types";
-import { Base, BinaryBoolean, Pagination, Success, UID } from '../base';
+import {Base, BinaryBoolean, ExtendedPagination, Pagination, Success, UID} from '../base';
 
 export class Playlists extends Base {
     /**
@@ -15,6 +15,8 @@ export class Playlists extends Base {
      * @param [params.show_dupes] 0, 1 (if true ignore 'api_hide_dupe_searches' setting)
      * @param [params.offset]
      * @param [params.limit]
+     * @param [params.cond]
+     * @param [params.sort]
      * @see {@link https://ampache.org/api/api-json-methods#playlists}
      */
     async playlists (params?: {
@@ -24,7 +26,7 @@ export class Playlists extends Base {
         update?: Date,
         hide_search?: BinaryBoolean,
         show_dupes?: BinaryBoolean,
-    } & Pagination) {
+    } & ExtendedPagination) {
         let query = 'playlists';
         query += qs.stringify(params, '&');
         let data = await this.request<{playlist: Playlist[]}>(query);
@@ -87,6 +89,8 @@ export class Playlists extends Base {
      * @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]
+     * @param [params.cond]
+     * @param [params.sort]
      * @see {@link https://ampache.org/api/api-json-methods#user_playlists}
      */
     async userPlaylists (params?: {
@@ -94,7 +98,7 @@ export class Playlists extends Base {
         exact?: BinaryBoolean,
         add?: Date,
         update?: Date,
-    } & Pagination) {
+    } & ExtendedPagination) {
         let query = 'user_playlists';
         query += qs.stringify(params, '&');
         let data = await this.request<{playlist: Playlist[]}>(query);
@@ -110,6 +114,8 @@ export class Playlists extends Base {
      * @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]
+     * @param [params.cond]
+     * @param [params.sort]
      * @see {@link https://ampache.org/api/api-json-methods#user_smartlists}
      */
     async userSmartlists (params?: {
@@ -117,7 +123,7 @@ export class Playlists extends Base {
         exact?: BinaryBoolean,
         add?: Date,
         update?: Date,
-    } & Pagination) {
+    } & ExtendedPagination) {
         let query = 'user_smartlists';
         query += qs.stringify(params, '&');
         let data = await this.request<{playlist: Playlist[]}>(query);
@@ -159,7 +165,7 @@ export class Playlists extends Base {
     }
 
     /**
-     * This modifies name and type of a playlist.
+     * 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 params.filter UID to find

package/src/podcasts/index.ts

@@ -1,6 +1,6 @@
 import qs from 'querystringify';
 import { Podcast, PodcastEpisode, DeletedPodcastEpisode } from './types';
-import { Base, Pagination, Success, UID } from '../base';
+import {Base, ExtendedPagination, Pagination, Success, UID} from '../base';
 
 export class Podcasts extends Base {
     /**
@@ -10,12 +10,14 @@ export class Podcasts extends Base {
      * @param [params.include] episodes (include podcast_episodes in the response)
      * @param [params.offset]
      * @param [params.limit]
+     * @param [params.cond]
+     * @param [params.sort]
      * @see {@link https://ampache.org/api/api-json-methods#podcasts}
      */
     async podcasts (params?: {
         filter?: string,
         include?: 'episodes',
-    } & Pagination) {
+    } & ExtendedPagination) {
         let query = 'podcasts';
         query += qs.stringify(params, '&');
         let data = await this.request<{podcast: Podcast[]}>(query);
@@ -102,11 +104,13 @@ export class Podcasts extends Base {
      * @param params.filter UID of podcast
      * @param [params.offset]
      * @param [params.limit]
+     * @param [params.cond]
+     * @param [params.sort]
      * @see {@link https://ampache.org/api/api-json-methods#podcast_episodes}
      */
     async podcastEpisodes (params: {
         filter: UID,
-    } & Pagination) {
+    } & ExtendedPagination) {
         let query = 'podcast_episodes';
         query += qs.stringify(params, '&');
         let data = await this.request<{podcast_episode: PodcastEpisode[]}>(query);

package/src/shares/index.ts

@@ -1,6 +1,6 @@
 import qs from 'querystringify';
 import { Share } from './types';
-import { Base, BinaryBoolean, Pagination, Success, UID } from '../base';
+import { Base, BinaryBoolean, ExtendedPagination, Success, UID } from '../base';
 
 export class Shares extends Base {
     /**
@@ -10,12 +10,14 @@ export class Shares extends Base {
      * @param [params.exact] 0, 1 boolean to match the exact filter string
      * @param [params.offset]
      * @param [params.limit]
+     * @param [params.cond]
+     * @param [params.sort]
      * @see {@link https://ampache.org/api/api-json-methods#shares}
      */
     async shares (params?: {
         filter?: string,
         exact?: BinaryBoolean,
-    } & Pagination) {
+    } & ExtendedPagination) {
         let query = 'shares';
         query += qs.stringify(params, '&');
         let data = await this.request<{share: Share[]}>(query);

package/src/songs/index.ts

@@ -1,6 +1,6 @@
 import qs from 'querystringify';
 import { Song, DeletedSong } from './types';
-import { Base, BinaryBoolean, Pagination, Success, UID } from '../base';
+import {Base, BinaryBoolean, ExtendedPagination, Pagination, Success, UID} from '../base';
 
 export class Songs extends Base {
     /**
@@ -12,6 +12,8 @@ export class Songs extends Base {
      * @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]
+     * @param [params.cond]
+     * @param [params.sort]
      * @see {@link https://ampache.org/api/api-json-methods#songs}
      */
     async songs (params?: {
@@ -19,7 +21,7 @@ export class Songs extends Base {
         exact?: BinaryBoolean,
         add?: Date,
         update?: Date,
-    } & Pagination) {
+    } & ExtendedPagination) {
         let query = 'songs';
         query += qs.stringify(params, '&');
         let data = await this.request<{song: Song[]}>(query);
@@ -47,12 +49,14 @@ export class Songs extends Base {
      * @param [params.top50] 0, 1 (if true filter to the artist top 50)
      * @param [params.offset]
      * @param [params.limit]
+     * @param [params.cond]
+     * @param [params.sort]
      * @see {@link https://ampache.org/api/api-json-methods#artist_songs}
      */
     async artistSongs (params: {
         filter: UID,
         top50?: BinaryBoolean,
-    } & Pagination) {
+    } & ExtendedPagination) {
         let query = 'artist_songs';
         query += qs.stringify(params, '&');
         let data = await this.request<{song: Song[]}>(query);
@@ -65,11 +69,13 @@ export class Songs extends Base {
      * @param params.filter UID to find
      * @param [params.offset]
      * @param [params.limit]
+     * @param [params.cond]
+     * @param [params.sort]
      * @see {@link https://ampache.org/api/api-json-methods#album_songs}
      */
     async albumSongs (params: {
         filter: UID,
-    } & Pagination) {
+    } & ExtendedPagination) {
         let query = 'album_songs';
         query += qs.stringify(params, '&');
         let data = await this.request<{song: Song[]}>(query);
@@ -82,11 +88,13 @@ export class Songs extends Base {
      * @param params.filter UID to find
      * @param [params.offset]
      * @param [params.limit]
+     * @param [params.cond]
+     * @param [params.sort]
      * @see {@link https://ampache.org/api/api-json-methods#genre_songs}
      */
     async genreSongs (params: {
         filter: UID,
-    } & Pagination) {
+    } & ExtendedPagination) {
         let query = 'genre_songs';
         query += qs.stringify(params, '&');
         let data = await this.request<{song: Song[]}>(query);
@@ -118,11 +126,13 @@ export class Songs extends Base {
      * @param params.filter UID to find
      * @param [params.offset]
      * @param [params.limit]
+     * @param [params.cond]
+     * @param [params.sort]
      * @see {@link https://ampache.org/api/api-json-methods#license_songs}
      */
     async licenseSongs (params: {
         filter: UID,
-    } & Pagination) {
+    } & ExtendedPagination) {
         let query = 'license_songs';
         query += qs.stringify(params, '&');
         let data = await this.request<{song: Song[]}>(query);

package/src/system/index.ts

@@ -1,7 +1,7 @@
 import qs from 'querystringify';
 import { Song } from "../songs/types";
 import { Artist } from "../artists/types";
-import { Base, BinaryBoolean, Pagination, Success, UID } from '../base';
+import {Base, BinaryBoolean, ExtendedPagination, Pagination, Success, UID} from '../base';
 import { Album } from '../albums/types';
 import { Video } from '../videos/types';
 import { Playlist } from '../playlists/types';
@@ -34,6 +34,8 @@ export class System extends Base {
      * @param [params.hide_search] 0, 1 (if true do not include searches/smartlists in the result)
      * @param [params.offset]
      * @param [params.limit]
+     * @param [params.cond]
+     * @param [params.sort]
      * @see {@link https://ampache.org/api/api-json-methods#get_indexes}
      * @deprecated Being removed in 7.0.0. Use `list` instead.
      */
@@ -44,7 +46,7 @@ export class System extends Base {
         update?: Date,
         include?: BinaryBoolean,
         hide_search?: BinaryBoolean
-    } & Pagination) {
+    } & ExtendedPagination) {
         let query = 'get_indexes';
         query += qs.stringify(params, '&');
         let data;
@@ -87,6 +89,8 @@ export class System extends Base {
      * @param [params.hide_search] 0, 1 (if true do not include searches/smartlists in the result)
      * @param [params.offset]
      * @param [params.limit]
+     * @param [params.cond]
+     * @param [params.sort]
      * @see {@link https://ampache.org/api/api-json-methods#list}
      */
     async list (params: {
@@ -95,7 +99,7 @@ export class System extends Base {
         add?: Date,
         update?: Date,
         hide_search?: BinaryBoolean
-    } & Pagination) {
+    } & ExtendedPagination) {
         let query = 'list';
         query += qs.stringify(params, '&');
         return this.request<{list: IndexEntry[]}>(query);
@@ -113,6 +117,8 @@ export class System extends Base {
      * @param [params.hide_search] 0, 1 (if true do not include searches/smartlists in the result)
      * @param [params.offset]
      * @param [params.limit]
+     * @param [params.cond]
+     * @param [params.sort]
      * @see {@link https://ampache.org/api/api-json-methods#index}
      */
     async index (params: {
@@ -123,7 +129,7 @@ export class System extends Base {
         update?: Date,
         include?: BinaryBoolean,
         hide_search?: BinaryBoolean
-    } & Pagination) {
+    } & ExtendedPagination) {
         let query = 'index';
         query += qs.stringify(params, '&');
         return this.request<{index: []}>(query);
@@ -140,6 +146,8 @@ export class System extends Base {
      * @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]
+     * @param [params.cond]
+     * @param [params.sort]
      * @see {@link https://ampache.org/api/api-json-methods#browse}
      */
     async browse (params: {
@@ -148,7 +156,7 @@ export class System extends Base {
         catalog?: number,
         add?: Date,
         update?: Date,
-    } & Pagination) {
+    } & ExtendedPagination) {
         let query = 'browse';
         query += qs.stringify(params, '&');
         return this.request<{browse: IndexEntry[]}>(query);
@@ -383,7 +391,7 @@ export class System extends Base {
      * @param params.id UID to find
      * @param params.type Object type
      * @param [params.bitrate] Max bitrate for transcoding
-     * @param [params.format] mp3, ogg, raw, etc (raw returns the original format)
+     * @param [params.format] mp3, ogg, raw, etc. (raw returns the original format)
      * @param [params.offset] Time offset
      * @param [params.length] 0, 1 (estimate content length)
      * @see {@link https://ampache.org/api/api-json-methods#stream}
@@ -407,7 +415,7 @@ export class System extends Base {
      * @remarks MINIMUM_API_VERSION=400001
      * @param params.id UID to find
      * @param params.type Object type
-     * @param [params.format] mp3, ogg, raw, etc (raw returns the original format)
+     * @param [params.format] mp3, ogg, raw, etc. (raw returns the original format)
      * @see {@link https://ampache.org/api/api-json-methods#download}
      */
     download (params: {

package/src/users/index.ts

@@ -1,6 +1,6 @@
 import qs from 'querystringify';
 import { User, UserSummary, Activity } from './types';
-import { Base, BinaryBoolean, Success } from '../base';
+import {Base, BinaryBoolean, ExtendedPagination, Success} from '../base';
 
 export class Users extends Base {
     /**
@@ -165,11 +165,15 @@ export class Users extends Base {
      * This gets the followers for the requested username
      * @remarks MINIMUM_API_VERSION=380001
      * @param params.username UID to find
+     * @param [params.offset]
+     * @param [params.limit]
+     * @param [params.cond]
+     * @param [params.sort]
      * @see {@link https://ampache.org/api/api-json-methods#followers}
      */
     async followers (params: {
         username: string,
-    }) {
+    } & ExtendedPagination ) {
         let query = 'followers';
         query += qs.stringify(params, '&');
         let data = await this.request<{user: UserSummary[]}>(query);