javascript-ampache 1.0.7 → 1.0.8

package/dist/albums/index.d.ts

@@ -1,5 +1,5 @@
 import { Album } from './types';
-import { Base, BinaryBoolean, Pagination, UID } from '../base';
+import { Base, BinaryBoolean, ExtendedPagination, UID } from '../base';
 export declare class Albums extends Base {
     /**
      * This returns albums based on the provided search filters
@@ -11,6 +11,8 @@ export declare class Albums extends Base {
      * @param [params.include] albums, songs (include child objects in the response)
      * @param [params.offset]
      * @param [params.limit]
+     * @param [params.cond]
+     * @param [params.sort]
      * @see {@link https://ampache.org/api/api-json-methods#albums}
      */
     albums(params?: {
@@ -19,7 +21,7 @@ export declare class Albums extends Base {
         add?: Date;
         update?: Date;
         include?: "albums" | "songs";
-    } & Pagination): Promise<Album[] | {
+    } & ExtendedPagination): Promise<Album[] | {
         album: Album[];
     }>;
     /**
@@ -39,11 +41,13 @@ export declare class Albums 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#artist_albums}
      */
     artistAlbums(params: {
         filter: UID;
-    } & Pagination): Promise<Album[] | {
+    } & ExtendedPagination): Promise<Album[] | {
         album: Album[];
     }>;
     /**
@@ -52,11 +56,13 @@ export declare class Albums 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_albums}
      */
     genreAlbums(params?: {
         filter: UID;
-    } & Pagination): Promise<Album[] | {
+    } & ExtendedPagination): Promise<Album[] | {
         album: Album[];
     }>;
 }

package/dist/artists/index.d.ts

@@ -1,5 +1,5 @@
 import { Artist } from './types';
-import { Base, BinaryBoolean, Pagination, UID } from '../base';
+import { Base, BinaryBoolean, ExtendedPagination, UID } from '../base';
 export declare class Artists extends Base {
     /**
      * This takes a collection of inputs and returns artist objects
@@ -12,6 +12,8 @@ export declare class Artists extends Base {
      * @param [params.album_artist] 0, 1 (if true filter for album artists only)
      * @param [params.offset]
      * @param [params.limit]
+     * @param [params.cond]
+     * @param [params.sort]
      * @see {@link https://ampache.org/api/api-json-methods#artists}
      */
     artists(params?: {
@@ -21,7 +23,7 @@ export declare class Artists extends Base {
         update?: Date;
         include?: 'albums' | 'songs';
         album_artist?: BinaryBoolean;
-    } & Pagination): Promise<Artist[] | {
+    } & ExtendedPagination): Promise<Artist[] | {
         artist: Artist[];
     }>;
     /**
@@ -41,11 +43,13 @@ export declare class Artists 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_artists}
      */
     genreArtists(params: {
         filter: UID;
-    } & Pagination): Promise<Artist[] | {
+    } & ExtendedPagination): Promise<Artist[] | {
         artist: Artist[];
     }>;
     /**
@@ -54,11 +58,13 @@ export declare class Artists extends Base {
      * @param params.filter UID of find
      * @param [params.offset]
      * @param [params.limit]
+     * @param [params.cond]
+     * @param [params.sort]
      * @see {@link https://ampache.org/api/api-json-methods#label_artists}
      */
     labelArtists(params: {
         filter: UID;
-    } & Pagination): Promise<Artist[] | {
+    } & ExtendedPagination): Promise<Artist[] | {
         artist: Artist[];
     }>;
 }

package/dist/base.d.ts

@@ -14,6 +14,16 @@ export type Pagination = {
     offset?: number;
     limit?: number;
 };
+/**
+ * @param [offset] Return results starting from this index position
+ * @param [limit] Maximum number of results to return
+ * @param [cond] Apply additional filters to the browse using ; separated comma string pairs (e.g. 'filter1,value1;filter2,value2')
+ * @param [sort] Sort name or comma-separated key pair. (e.g. 'name,order') Default order 'ASC' (e.g. 'name,ASC' == 'name')
+ */
+export type ExtendedPagination = Pagination & {
+    cond?: string;
+    sort?: string;
+};
 export type BinaryBoolean = 0 | 1;
 export type UID = string | number;
 export declare abstract class Base {

package/dist/bookmarks/index.d.ts

@@ -26,7 +26,7 @@ export declare class Bookmarks extends Base {
         bookmark: Bookmark[];
     }>;
     /**
-     * Get the bookmark from it's object_id and object_type.
+     * Get the bookmark from its object_id and object_type.
      * @remarks MINIMUM_API_VERSION=5.0.0
      * @param params.filter UID to find
      * @param params.type Object type

package/dist/catalogs/index.d.ts

@@ -1,15 +1,19 @@
 import { Catalog } from './types';
-import { Base, Success, UID } from '../base';
+import { Base, ExtendedPagination, Success, UID } from '../base';
 export declare class Catalogs extends Base {
     /**
      * This searches the catalogs and returns... catalogs
      * @remarks MINIMUM_API_VERSION=420000
      * @param [params.filter] Catalog type
+     * @param [params.offset]
+     * @param [params.limit]
+     * @param [params.cond]
+     * @param [params.sort]
      * @see {@link https://ampache.org/api/api-json-methods#catalogs}
      */
     catalogs(params?: {
         filter?: 'music' | 'clip' | 'tvshow' | 'movie' | 'personal_video' | 'podcast';
-    }): Promise<Catalog[] | {
+    } & ExtendedPagination): Promise<Catalog[] | {
         catalog: Catalog[];
     }>;
     /**

package/dist/genres/index.d.ts

@@ -1,5 +1,5 @@
 import { Genre } from './types';
-import { Base, BinaryBoolean, Pagination, UID } from '../base';
+import { Base, BinaryBoolean, ExtendedPagination, UID } from '../base';
 export declare class Genres extends Base {
     /**
      * This returns the genres (Tags) based on the specified filter
@@ -8,12 +8,14 @@ export declare class Genres extends Base {
      * @param [params.exact] 0, 1 (if true filter is exact = rather than fuzzy LIKE)
      * @param [params.offset]
      * @param [params.limit]
+     * @param [params.cond]
+     * @param [params.sort]
      * @see {@link https://ampache.org/api/api-json-methods#genres}
      */
     genres(params?: {
         filter?: string;
         exact?: BinaryBoolean;
-    } & Pagination): Promise<Genre[] | {
+    } & ExtendedPagination): Promise<Genre[] | {
         genre: Genre[];
     }>;
     /**