Bullhorn-Types
Typescript Interfaces for the Bullhorn REST Api
Setup
npm install @bullhorn/bullhorn-types
Usage
import { EntityTypes, Candidate } from "@bullhorn/bullhorn-types";
console.log(EntityTypes.Candidate === "Candidate"); // outputs: true
let person: Candidate = {
firstName: "John",
lastName: "smith",
};
Build from Meta using the Bullhorn CLI
# Clone this repo
git clone [email protected]:bullhorn/bullhorn-types.git
cd bullhorn-types
npm install
# create directory where tool will generate file
mkdir typings
# Login into the Bullhorn Environment
npx bullhorn config set environment http://<qabox>-backend.bh-bos2.bullhorn.com:8182
npx bullhorn auth login
# Generate the typings file
npx bullhorn typings generate
Contributing
This repo uses semantic-release, which reads the type of each commit to decide the next version. Ensure commits and pull requests are prepended with the proper commit type.
<type>(<scope>): <subject>
Example: feat(typings): add ListExportFile entity
Deploy
GitHub Actions will build a deploy to NPM when you push to master with appropriate Semantice Release messages.