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

An unofficial helper package for accessing the Lightcast API endpoints

import { LightcastAPIClient } from "../..";
import type { QueryParameters } from "./common-types";
import type { Response } from "../common-types";
/**
 * @see API docs {@link https://docs.lightcast.dev/apis/canada-job-postings#taxonomies}
 */
declare const _default: (client: LightcastAPIClient) => {
    lookup: {
        /**
         * Look up taxonomy items by IDs.
         * @param body
         * @param params
         * @returns
         * @See API docs {@link https://docs.lightcast.dev/apis/canada-job-postings#post-taxonomies-facet-lookup}
         */
        byFacet: <R = Response, B = {
            ids: (string | number)[];
        }>(facet: string, body: B, params?: QueryParameters | undefined) => Promise<import("axios").AxiosResponse<R, any>>;
    };
    /**
     * Search taxonomies using either whole keywords (relevance search) or partial keywords (autocomplete).
     * @param body
     * @param params
     * @returns
     * @See API docs {@link https://docs.lightcast.dev/apis/canada-job-postings#get-taxonomies-facet}
     */
    search: <R_1 = Response>(facet: string, params?: {
        q?: string;
        autocomplete?: boolean;
        limit?: number;
    } & QueryParameters) => Promise<import("axios").AxiosResponse<R_1, any>>;
    /**
     * Get a list of current available taxonomy facets.
     * @see API docs {@link https://docs.lightcast.dev/apis/canada-job-postings#get-taxonomies}
     */
    listAllFacets: <R_2 = Response<string[]>>() => Promise<import("axios").AxiosResponse<R_2, any>>;
};
export default _default;