UNPKG

@plastic-ant/lightcast-api

Version:

An unofficial helper package for accessing the Lightcast API endpoints

42 lines (41 loc) 3.31 kB
import { LightcastAPIClient } from "../.."; import type { Response, Status } from "../common-types"; declare const _default: (client: LightcastAPIClient) => { status: () => Promise<import("typed-rest-client").IRestResponse<Response<Status>>>; meta: <R = Response>() => Promise<import("typed-rest-client").IRestResponse<R>>; postings: { byId: <R_1 = Response>(id: string, params?: import("./common-types").QueryParameters | undefined) => Promise<import("typed-rest-client").IRestResponse<R_1>>; filtered: <R_2 = Response>(body: import("type-fest").JsonObject, params?: import("./common-types").QueryParameters | undefined) => Promise<import("typed-rest-client").IRestResponse<R_2>>; }; rankings: { timeseries: { byFacet: <R_3 = Response>(facet: string, body: import("type-fest").JsonObject, params?: import("./common-types").QueryParameters | undefined) => Promise<import("typed-rest-client").IRestResponse<R_3>>; }; distributions: (distributionFacet: string) => { byFacet: <R_4 = Response>(facet: string, body: import("type-fest").JsonObject, params?: import("./common-types").QueryParameters | undefined) => Promise<import("typed-rest-client").IRestResponse<R_4>>; }; listAllFacets: <R_5 = Response<string[]>>() => Promise<import("typed-rest-client").IRestResponse<R_5>>; byNestedFacet: <R_6 = Response>(facet: string, nestedFacet: string, body: import("type-fest").JsonObject, params?: import("./common-types").QueryParameters | undefined) => Promise<import("typed-rest-client").IRestResponse<R_6>>; byFacet: <R_7 = Response>(facet: string, body: import("type-fest").JsonObject, params?: import("./common-types").QueryParameters | undefined) => Promise<import("typed-rest-client").IRestResponse<R_7>>; }; taxonomies: { lookup: { byFacet: <R_8 = Response>(facet: string, body: { ids: (string | number)[]; }, params?: import("./common-types").QueryParameters | undefined) => Promise<import("typed-rest-client").IRestResponse<R_8>>; }; search: <R_9 = Response>(facet: string, params?: ({ q?: string | undefined; autocomplete?: boolean | undefined; limit?: number | undefined; } & import("./common-types").QueryParameters) | undefined) => Promise<import("typed-rest-client").IRestResponse<R_9>>; listAllFacets: <R_10 = Response<string[]>>() => Promise<import("typed-rest-client").IRestResponse<R_10>>; }; totals: <R_11 = Response>(body: import("type-fest").JsonObject, params?: import("./common-types").QueryParameters | undefined) => Promise<import("typed-rest-client").IRestResponse<R_11>>; timeseries: <R_12 = Response>(body: import("type-fest").JsonObject, params?: import("./common-types").QueryParameters | undefined) => Promise<import("typed-rest-client").IRestResponse<R_12>>; distributions: { byFacet: <R_13 = Response>(facet: string, body: import("type-fest").JsonObject, params?: import("./common-types").QueryParameters | undefined) => Promise<import("typed-rest-client").IRestResponse<R_13>>; listAllDimensions: <R_14 = Response>() => Promise<import("typed-rest-client").IRestResponse<R_14>>; }; }; export default _default;