@plastic-ant/lightcast-api
Version:
An unofficial helper package for accessing the Lightcast API endpoints
101 lines (100 loc) • 4.11 kB
TypeScript
import { LightcastAPIClient } from "../..";
import type { Response, Status } from "../common-types";
declare const _default: (client: LightcastAPIClient) => {
/**
*
* @returns
* @See API docs {@link https://docs.lightcast.dev/apis/career-pathways#get-get-service-status}
*/
status: () => Promise<import("axios").AxiosResponse<Response<Status>, any>>;
/**
*
* @returns
* @See API docs {@link https://docs.lightcast.dev/apis/career-pathways#get-get-service-metadata}
*/
meta: <R = Response>() => Promise<import("axios").AxiosResponse<R, any>>;
dimensions: {
/**
* Get a list of supported dimensions.
* @returns
* @see API docs {@link https://docs.lightcast.dev/apis/career-pathways#get-list-all-dimensions}
*/
listAllFacets: <R_1 = Response<string[]>>() => Promise<import("axios").AxiosResponse<R_1, any>>;
dimension: (facet: "soc" | "onet" | "lotocc" | "lotspecocc") => {
/**
*
* @returns
* @see API docs {@link https://docs.lightcast.dev/apis/career-pathways#dimensions-dimension}
*/
meta: <R_2 = Response>() => Promise<import("axios").AxiosResponse<R_2, any>>;
/**
*
* @param body
* @returns
* @see API docs {@link https://docs.lightcast.dev/apis/career-pathways#dimensions-dimension-feederjobs}
*/
feederJobs: <R_3 = Response, B = {
id: string;
responseIds?: string[] | undefined;
categories?: string[] | undefined;
limit?: number | undefined;
region?: {
nation: string;
level?: string | undefined;
id?: string | undefined;
} | undefined;
}>(body: B) => Promise<import("axios").AxiosResponse<R_3, any>>;
/**
*
* @param body
* @returns
* @see API docs {@link https://docs.lightcast.dev/apis/career-pathways#dimensions-dimension-nextstepjobs}
*/
nextStepJobs: <R_4 = Response, B_1 = {
id: string;
responseIds?: string[] | undefined;
categories?: string[] | undefined;
limit?: number | undefined;
region?: {
nation: string;
level?: string | undefined;
id?: string | undefined;
} | undefined;
}>(body: B_1) => Promise<import("axios").AxiosResponse<R_4, any>>;
/**
*
* @param body
* @returns
* @see API docs {@link https://docs.lightcast.dev/apis/career-pathways#dimensions-dimension-skillgap}
*/
skillGap: <R_5 = Response, B_2 = {
sourceId: string;
destinationId: string;
limit?: number | undefined;
region?: {
nation: string;
level?: string | undefined;
id?: string | undefined;
} | undefined;
}>(body: B_2) => Promise<import("axios").AxiosResponse<R_5, any>>;
/**
* Get feeder and next step responses for a list of occupations.
* @param body
* @returns
* @see API docs {@link https://docs.lightcast.dev/apis/career-pathways#dimensions-dimension-bulk}
*/
bulk: <R_6 = Response, B_3 = {
id: string;
responseIds?: string[] | undefined;
categories?: string[] | undefined;
limit?: number | undefined;
region?: {
nation: string;
level?: string | undefined;
id?: string | undefined;
} | undefined;
}>(body: B_3) => Promise<import("axios").AxiosResponse<R_6, any>>;
};
};
};
export default _default;