UNPKG

javascript-ampache

Version:
33 lines (32 loc) 1.36 kB
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>; }