javascript-ampache 1.2.0 → 2.0.0

package/dist/base.d.ts

@@ -1,47 +0,0 @@
-type Config = {
-    url: string;
-    sessionKey?: string;
-    useBearerToken?: boolean;
-    debug?: boolean;
-};
-export type Success = {
-    success: string;
-};
-/**
- * @param [offset] Return results starting from this index position
- * @param [limit] Maximum number of results to return
- */
-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 {
-    sessionKey: string;
-    url: string;
-    version: string;
-    useBearerToken: boolean;
-    debug: boolean;
-    constructor(config: Config);
-    protected request<T>(endpoint: string): Promise<T>;
-    protected binary<T>(endpoint: string): Promise<Blob>;
-    setSessionKey(sessionKey: string): void;
-    /**
-     * Construct and return a URL
-     * @param endpoint
-     * @param [params]
-     */
-    rawURL(endpoint: string, params?: {}): string;
-}
-export {};

package/dist/bookmarks/index.d.ts

@@ -1,91 +0,0 @@
-import { BookmarkResponse, BookmarksResponse } from "./types";
-import { Base, BinaryBoolean, Success, UID } from "../base";
-export declare class Bookmarks extends Base {
-    /**
-     * Get a single bookmark by bookmark_id
-     * @remarks MINIMUM_API_VERSION=6.1.0
-     * @param params.filter UID to find
-     * @param [params.include] 0,1, if true include the object in the bookmark
-     * @see {@link https://ampache.org/api/api-json-methods#bookmark}
-     */
-    bookmark(params: {
-        filter: UID;
-        include?: BinaryBoolean;
-    }): Promise<BookmarkResponse>;
-    /**
-     * Get information about bookmarked media this user is allowed to manage
-     * @remarks MINIMUM_API_VERSION=5.0.0
-     * @param [params.client] filter by the agent/client name
-     * @param [params.include] 0,1, if true include the object in the bookmark
-     * @see {@link https://ampache.org/api/api-json-methods#bookmarks}
-     */
-    bookmarks(params: {
-        client?: string;
-        include?: BinaryBoolean;
-    }): Promise<BookmarksResponse>;
-    /**
-     * Get the bookmark/s 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
-     * @param [params.include] 0,1, if true include the object in the bookmark
-     * @see {@link https://ampache.org/api/api-json-methods#get_bookmark}
-     */
-    getBookmark(params: {
-        filter: UID;
-        type: "song" | "video" | "podcast_episode";
-        include?: BinaryBoolean;
-        all?: BinaryBoolean;
-    }): Promise<BookmarkResponse>;
-    /**
-     * Create a placeholder for the current media that you can return to later.
-     * @remarks MINIMUM_API_VERSION=5.0.0
-     * @param params.filter UID to find
-     * @param params.type Object type
-     * @param params.position current track time in seconds
-     * @param [params.client] Agent string. (Default: 'AmpacheAPI')
-     * @param [params.date] update time (Default: UNIXTIME())
-     * @param [params.include] 0,1, if true include the object in the bookmark
-     * @see {@link https://ampache.org/api/api-json-methods#bookmark_create}
-     */
-    bookmarkCreate(params: {
-        filter: UID;
-        type: "song" | "video" | "podcast_episode";
-        position: number;
-        client?: string;
-        date?: number;
-        include?: BinaryBoolean;
-    }): Promise<BookmarkResponse>;
-    /**
-     * Edit a placeholder for the current media that you can return to later.
-     * @remarks MINIMUM_API_VERSION=5.0.0
-     * @param params.filter UID to find
-     * @param params.type Object type
-     * @param params.position current track time in seconds
-     * @param [params.client] Agent string. (Default: 'AmpacheAPI')
-     * @param [params.date] update time (Default: UNIXTIME())
-     * @param [params.include] 0,1, if true include the object in the bookmark
-     * @see {@link https://ampache.org/api/api-json-methods#bookmark_edit}
-     */
-    bookmarkEdit(params: {
-        filter: UID;
-        type: "song" | "video" | "podcast_episode";
-        position: number;
-        client?: string;
-        date?: number;
-        include?: BinaryBoolean;
-    }): Promise<BookmarkResponse>;
-    /**
-       * Delete an existing bookmark. (if it exists)
-       * @remarks MINIMUM_API_VERSION=5.0.0
-       * @param params.filter UID to find
-       * @param params.type Object type
-       * @param [params.client] Agent string. (Default: 'AmpacheAPI')
-       @see {@link https://ampache.org/api/api-json-methods#bookmark_delete}
-       */
-    bookmarkDelete(params: {
-        filter: UID;
-        type: "song" | "video" | "podcast_episode";
-        client?: string;
-    }): Promise<Success>;
-}

package/dist/bookmarks/types.d.ts

@@ -1,13 +0,0 @@
-import { UID } from "../base";
-export type BookmarkResponse = {
-    id: UID;
-    type: "song" | "video" | "podcast_episode";
-    position: number;
-    client?: string;
-    date?: number;
-};
-export type BookmarksResponse = {
-    total_count: number;
-    md5: string;
-    bookmark: BookmarkResponse[];
-};

package/dist/catalogs/index.d.ts

@@ -1,87 +0,0 @@
-import { CatalogResponse, CatalogsResponse } from "./types";
-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";
-    } & ExtendedPagination): Promise<CatalogsResponse>;
-    /**
-     * Return catalog by UID
-     * @remarks MINIMUM_API_VERSION=420000
-     * @param params.filter UID to find
-     * @see {@link https://ampache.org/api/api-json-methods#catalog}
-     */
-    catalog(params: {
-        filter: UID;
-    }): Promise<CatalogResponse>;
-    /**
-     * Kick off a catalog update or clean for the selected catalog
-     * ACCESS REQUIRED: 75 (Catalog Manager)
-     * @remarks MINIMUM_API_VERSION=400001
-     * @param params.task add_to_catalog, clean_catalog
-     * @param params.catalog UID of catalog
-     * @see {@link https://ampache.org/api/api-json-methods#catalog_action}
-     */
-    catalogAction(params: {
-        task: "add_to_catalog" | "clean_catalog";
-        catalog: UID;
-    }): Promise<Success>;
-    /**
-     * Perform actions on local catalog files. Single file versions of catalog add, clean, verify and remove (delete).
-     * Make sure you remember to urlencode those file names!
-     * ACCESS REQUIRED: 50 (Content Manager)
-     * @remarks MINIMUM_API_VERSION=420000
-     * @param params.file FULL path to local file
-     * @param params.task add, clean, verify, remove, (can include comma-separated values)
-     * @param params.catalog UID of catalog
-     * @see {@link https://ampache.org/api/api-json-methods#catalog_file}
-     */
-    catalogFile(params: {
-        file: string;
-        task: string;
-        catalog: UID;
-    }): Promise<Success>;
-    /**
-     * 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;
-    }): Promise<CatalogResponse>;
-    /**
-     * 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;
-    }): Promise<Success>;
-}

package/dist/catalogs/types.d.ts

@@ -1,19 +0,0 @@
-import { UID } from "../base";
-export type CatalogResponse = {
-    id: UID;
-    name: string;
-    type: "local" | "remote";
-    gather_types: "podcast" | "clip" | "tvshow" | "movie" | "personal_video" | "music";
-    enabled: boolean;
-    last_add: number;
-    last_clean: number;
-    last_update: number;
-    path: string;
-    rename_pattern: string;
-    sort_pattern: string;
-};
-export type CatalogsResponse = {
-    total_count: number;
-    md5: string;
-    catalog: CatalogResponse[];
-};

package/dist/genres/index.d.ts

@@ -1,28 +0,0 @@
-import { GenreResponse, GenresResponse } from "./types";
-import { Base, BinaryBoolean, ExtendedPagination, UID } from "../base";
-export declare class Genres extends Base {
-    /**
-     * This returns the genres (Tags) based on the specified filter
-     * @remarks MINIMUM_API_VERSION=380001
-     * @param [params.filter] UID to find
-     * @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;
-    } & ExtendedPagination): Promise<GenresResponse>;
-    /**
-     * This returns a single genre based on UID
-     * @remarks MINIMUM_API_VERSION=380001
-     * @param params.filter UID to find
-     * @see {@link https://ampache.org/api/api-json-methods#genre}
-     */
-    genre(params: {
-        filter: UID;
-    }): Promise<GenreResponse>;
-}

package/dist/genres/types.d.ts

@@ -1,22 +0,0 @@
-import { UID } from "../base";
-export type GenreSummary = {
-    id: UID;
-    name: string;
-};
-export type GenreResponse = {
-    id: UID;
-    name: string;
-    albums: number;
-    artists: number;
-    songs: number;
-    videos: number;
-    playlists: number;
-    live_streams: number;
-    is_hidden: boolean;
-    merge: GenreSummary[];
-};
-export type GenresResponse = {
-    total_count: number;
-    md5: string;
-    genre: GenreResponse[];
-};

package/dist/index.d.ts

@@ -1,24 +0,0 @@
-import { Albums } from "./albums";
-import { Artists } from "./artists";
-import { Auth } from "./auth";
-import { Bookmarks } from "./bookmarks";
-import { Catalogs } from "./catalogs";
-import { Genres } from "./genres";
-import { Labels } from "./labels";
-import { Licenses } from "./licenses";
-import { LiveStreams } from "./live-streams";
-import { Playlists } from "./playlists";
-import { Podcasts } from "./podcasts";
-import { Preferences } from "./preferences";
-import { Shares } from "./shares";
-import { Shouts } from "./shouts";
-import { Songs } from "./songs";
-import { System } from "./system";
-import { Users } from "./users";
-import { Videos } from "./videos";
-import { Base } from "./base";
-declare class AmpacheAPI extends Base {
-}
-interface AmpacheAPI extends Albums, Artists, Auth, Bookmarks, Catalogs, Genres, Labels, Licenses, LiveStreams, Playlists, Podcasts, Preferences, Shares, Shouts, Songs, System, Users, Videos {
-}
-export default AmpacheAPI;

package/dist/labels/index.d.ts

@@ -1,32 +0,0 @@
-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
-     * @remarks MINIMUM_API_VERSION=420000
-     * @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]
-     * @param [params.cond]
-     * @param [params.sort]
-     * @see {@link https://ampache.org/api/api-json-methods#labels}
-     */
-    labels(params?: {
-        filter?: string;
-        exact?: BinaryBoolean;
-        add?: Date;
-        update?: Date;
-    } & ExtendedPagination): Promise<LabelsResponse>;
-    /**
-     * This returns a single label
-     * @remarks MINIMUM_API_VERSION=420000
-     * @param params.filter UID to find
-     * @see {@link https://ampache.org/api/api-json-methods#label}
-     */
-    label(params: {
-        filter: UID;
-    }): Promise<LabelResponse>;
-}

package/dist/labels/types.d.ts

@@ -1,18 +0,0 @@
-import { UID } from "../base";
-export type LabelResponse = {
-    id: UID;
-    name: string;
-    artists: number;
-    summary: string | null;
-    external_link: string | null;
-    address: string | null;
-    category: string | null;
-    email: string | null;
-    website: string | null;
-    user: UID;
-};
-export type LabelsResponse = {
-    total_count: number;
-    md5: string;
-    label: LabelResponse[];
-};

package/dist/licenses/index.d.ts

@@ -1,32 +0,0 @@
-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
-     * @remarks MINIMUM_API_VERSION=420000
-     * @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]
-     * @param [params.cond]
-     * @param [params.sort]
-     * @see {@link https://ampache.org/api/api-json-methods#licenses}
-     */
-    licenses(params?: {
-        filter?: string;
-        exact?: BinaryBoolean;
-        add?: Date;
-        update?: Date;
-    } & ExtendedPagination): Promise<LicensesResponse>;
-    /**
-     * This returns a single license
-     * @remarks MINIMUM_API_VERSION=420000
-     * @param params.filter UID to find
-     * @see {@link https://ampache.org/api/api-json-methods#license}
-     */
-    license(params: {
-        filter: UID;
-    }): Promise<LicenseResponse>;
-}

package/dist/licenses/types.d.ts

@@ -1,12 +0,0 @@
-import { UID } from "../base";
-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,80 +0,0 @@
-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
-     * @remarks MINIMUM_API_VERSION=5.1.0
-     * @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]
-     * @param [params.cond]
-     * @param [params.sort]
-     * @see {@link https://ampache.org/api/api-json-methods#live_streams}
-     */
-    liveStreams(params?: {
-        filter?: string;
-        exact?: BinaryBoolean;
-        add?: Date;
-        update?: Date;
-    } & ExtendedPagination): Promise<LiveStreamsResponse>;
-    /**
-     * This returns a single live_stream
-     * @remarks MINIMUM_API_VERSION=5.1.0
-     * @param params.filter UID to find
-     * @see {@link https://ampache.org/api/api-json-methods#live_stream}
-     */
-    liveStream(params: {
-        filter: UID;
-    }): Promise<LiveStreamResponse>;
-    /**
-     * 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<LiveStreamResponse>;
-    /**
-     * 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<LiveStreamResponse>;
-    /**
-     * 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/live-streams/types.d.ts

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