@plastic-ant/lightcast-api
Version:
An unofficial helper package for accessing the Lightcast API endpoints
55 lines (54 loc) • 2.21 kB
TypeScript
import { LightcastAPIClient } from "../..";
import type { Status, Response } from "../common-types";
declare const _default: (client: LightcastAPIClient) => {
/**
* Get the health of the service. Be sure to check the healthy attribute of the response.
* @returns
* @See API docs {@link https://docs.lightcast.dev/apis/ddn-api#get-get-service-status}
*/
status: () => Promise<import("axios").AxiosResponse<Response<Status>, any>>;
/**
* Get service metadata, including model taxonomy and dimension information along with attribution text.
* @returns
* @See API docs {@link https://docs.lightcast.dev/apis/ddn-api#get-get-service-metadata}
*/
meta: <R = Response>() => Promise<import("axios").AxiosResponse<R, any>>;
/**
* Get a list of supported dimensions.
* @param params
* @returns
* @set API docs {@link https://docs.lightcast.dev/apis/ddn-api#get-list-all-dimensions}
*/
listAllDimensions: <R_1 = Response<string[]>>(params?: {
tags?: string;
}) => Promise<import("axios").AxiosResponse<R_1, any>>;
/**
*
* @param dimension - The occupation dimension used for modeling Salary Boosting Skills.
* @returns
* @see API docs {@link https://docs.lightcast.dev/apis/ddn-api#dimensions}
*/
dimensions: (dimension: string) => {
/**
* Get dimension information.
* @returns
* @See API docs {@link https://docs.lightcast.dev/apis/ddn-api#get-get-dimension-metadata}
*/
meta: <R_2 = Response>() => Promise<import("axios").AxiosResponse<R_2, any>>;
/**
* Get lists of DDN skills for an occupation.
* @param body - { id: Occupation code of the dimension }
* @returns
* @see API docs {@link https://docs.lightcast.dev/apis/ddn-api#post-get-ddn}
*/
ddn: <R_3 = Response, B = {
id: string;
region?: {
nation: string;
level?: string | undefined;
id?: string | undefined;
} | undefined;
}>(body: B) => Promise<import("axios").AxiosResponse<R_3, any>>;
};
};
export default _default;