@plastic-ant/lightcast-api/src/lib/ca-jpa/index.d.ts

An unofficial helper package for accessing the Lightcast API endpoints

import { LightcastAPIClient } from "../..";
import type { Response, Status } from "../common-types";
declare const _default: (client: LightcastAPIClient) => {
    status: () => Promise<import("axios").AxiosResponse<Response<Status>, any>>;
    meta: <R = Response>() => Promise<import("axios").AxiosResponse<R, any>>;
    postings: {
        byId: <R_1 = Response>(id: string, params?: import("./common-types").QueryParameters | undefined) => Promise<import("axios").AxiosResponse<R_1, any>>;
        filtered: <R_2 = Response, B = unknown>(body: B, params?: import("./common-types").QueryParameters | undefined) => Promise<import("axios").AxiosResponse<R_2, any>>;
    };
    rankings: {
        timeseries: {
            byFacet: <R_3 = Response, B_1 = unknown>(facet: string, body: B_1, params?: import("./common-types").QueryParameters | undefined) => Promise<import("axios").AxiosResponse<R_3, any>>;
        };
        listAllFacets: <R_4 = Response<string[]>>() => Promise<import("axios").AxiosResponse<R_4, any>>;
        byNestedFacet: <R_5 = Response, B_2 = unknown>(facet: string, nestedFacet: string, body: B_2, params?: import("./common-types").QueryParameters | undefined) => Promise<import("axios").AxiosResponse<R_5, any>>;
        byFacet: <R_6 = Response, B_3 = unknown>(facet: string, body: B_3, params?: import("./common-types").QueryParameters | undefined) => Promise<import("axios").AxiosResponse<R_6, any>>;
    };
    taxonomies: {
        lookup: {
            byFacet: <R_7 = Response, B_4 = {
                ids: (string | number)[];
            }>(facet: string, body: B_4, params?: import("./common-types").QueryParameters | undefined) => Promise<import("axios").AxiosResponse<R_7, any>>;
        };
        search: <R_8 = Response>(facet: string, params?: ({
            q?: string | undefined;
            autocomplete?: boolean | undefined;
            limit?: number | undefined;
        } & import("./common-types").QueryParameters) | undefined) => Promise<import("axios").AxiosResponse<R_8, any>>;
        listAllFacets: <R_9 = Response<string[]>>() => Promise<import("axios").AxiosResponse<R_9, any>>;
    };
    totals: <R_10 = Response, B_5 = unknown>(body: B_5, params?: import("./common-types").QueryParameters | undefined) => Promise<import("axios").AxiosResponse<R_10, any>>;
    timeseries: {
        timeseries: <R_11 = Response, B_6 = unknown>(body: B_6, params?: import("./common-types").QueryParameters | undefined) => Promise<import("axios").AxiosResponse<R_11, any>>;
    };
    distributions: {
        byFacet: <R_12 = Response, B_7 = unknown>(facet: string, body: B_7, params?: import("./common-types").QueryParameters | undefined) => Promise<import("axios").AxiosResponse<R_12, any>>;
        listAllDimensions: <R_13 = Response<string[]>>() => Promise<import("axios").AxiosResponse<R_13, any>>;
    };
};
export default _default;