@plastic-ant/lightcast-api
Version:
An unofficial helper package for accessing the Lightcast API endpoints
80 lines (79 loc) • 2.96 kB
TypeScript
import type { JsonObject, JsonValue } from "type-fest";
import { LightcastAPIClient } from "../..";
import type { Response } from "../common-types";
declare const _default: (client: LightcastAPIClient) => {
/**
* A list of available taxonomies
* @param params
* @returns
* @set API docs {@link https://docs.lightcast.dev/apis/classification#get-list-all-taxonomies}
*/
listAll: <R = Response>(params?: {
tags?: string;
}) => Promise<import("axios").AxiosResponse<R, any>>;
/**
*
* @param facet
* @see API docs {@link https://docs.lightcast.dev/apis/classification#taxonomies-taxonomy}
*/
meta: <R_1 = Response>(facet: string) => Promise<import("axios").AxiosResponse<R_1, any>>;
/**
*
* @param facet
* @see API docs {@link https://docs.lightcast.dev/apis/classification#taxonomies-taxonomy-versions}
*/
versions: <R_2 = Response<string[]>>(facet: string) => Promise<import("axios").AxiosResponse<R_2, any>>;
version: (version: string) => {
/**
*
* @param facet
* @returns
* @see API docs {@link https://docs.lightcast.dev/apis/classification#taxonomies-taxonomy-versions-version}
*/
meta: <R_3 = Response>(facet: string) => Promise<import("axios").AxiosResponse<R_3, any>>;
/**
*
* @param facet
* @param params
* @returns
* @see API docs {@link https://docs.lightcast.dev/apis/classification#taxonomies-taxonomy-versions-version-concepts}
*/
concepts: <R_4 = Response<JsonValue[]>>(facet: string, params?: {
q?: string;
fields?: string;
filter?: string;
limit?: number;
after?: number;
locale?: string;
}) => Promise<import("axios").AxiosResponse<R_4, any>>;
/**
*
* @param facet
* @param id
* @param params
* @returns
* @see API docs {@link https://docs.lightcast.dev/apis/classification#taxonomies-taxonomy-versions-version-concepts-id}
*/
conceptsById: <R_5 = Response>(facet: string, id: string, params?: {
q?: string;
fields?: string;
filter?: string;
limit?: number;
after?: number;
locale?: string;
}) => Promise<import("axios").AxiosResponse<R_5, any>>;
/**
*
* @param facet
* @param params
* @returns
* @see API docs {@link https://docs.lightcast.dev/apis/classification#taxonomies-taxonomy-versions-version-relations}
*/
relations: <R_6 = Response, B = {
relationType: "child" | "sibling" | "any";
ids: string[];
filter?: JsonObject | undefined;
}>(facet: string, body: B) => Promise<import("axios").AxiosResponse<R_6, any>>;
};
};
export default _default;