@plastic-ant/lightcast-api
Version:
An unofficial helper package for accessing the Lightcast API endpoints
48 lines (47 loc) • 2.47 kB
TypeScript
import { LightcastAPIClient } from "../..";
import type { QueryParameters } from "./common-types";
import type { Response } from "../common-types";
declare const _default: (client: LightcastAPIClient) => {
timeseries: {
/**
* Group and rank postings by {facet} with a monthly or daily timeseries for each ranked group. Use YYYY-MM date format in the timeseries time-frame filter, timeseries.when, to get monthly summary of each ranked group, or use YYYY-MM-DD date format for daily summary.
* @param body
* @param params
* @returns
* @See API docs {@link https://docs.lightcast.dev/apis/job-postings#post-rankings-rankingfacet-timeseries}
*/
byFacet: <R = Response, B = unknown>(facet: string, body: B, params?: QueryParameters | undefined) => Promise<import("axios").AxiosResponse<R, any>>;
};
distributions: (distributionFacet: string) => {
/**
* Group and rank postings by {facet} with a distribution for each ranked item.
* @param body
* @param params
* @returns
* @See API docs {@link https://docs.lightcast.dev/apis/job-postings#post-rankings-rankingfacet-distributions-distributionfacet}
*/
byFacet: <R_1 = Response, B_1 = unknown>(facet: string, body: B_1, params?: QueryParameters) => Promise<import("axios").AxiosResponse<R_1, any>>;
};
/**
* Get a list of current available ranking facets.
* @see API docs {@link https://docs.lightcast.dev/apis/job-postings#get-rankings}
*/
listAllFacets: <R_2 = Response<string[]>>() => Promise<import("axios").AxiosResponse<R_2, any>>;
/**
* Group and rank postings by {facet}.
* @param body
* @param params
* @returns
* @See API docs {@link https://docs.lightcast.dev/apis/job-postings#post-rankings-rankingfacet-timeseries}
*/
byNestedFacet: <R_3 = Response, B_2 = unknown>(facet: string, nestedFacet: string, body: B_2, params?: QueryParameters) => Promise<import("axios").AxiosResponse<R_3, any>>;
/**
* Group and rank postings by {facet}.
* @param body
* @param params
* @returns
* @See API docs {@link https://docs.lightcast.dev/apis/job-postings#post-rankings-rankingfacet-timeseries}
*/
byFacet: <R_4 = Response, B_3 = unknown>(facet: string, body: B_3, params?: QueryParameters) => Promise<import("axios").AxiosResponse<R_4, any>>;
};
export default _default;