bullhorn / bullhorn-types

Entity Utils and Typescript Interfaces for the Bullhorn REST Api

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

Deploy

GitHub Actions will build a deploy to NPM when you push to master with appropriate Semantice Release messages.

bullhorn-types's Issues

The automated release is failing 🚨

🚨 The automated release from the master branch failed. 🚨

I recommend you give this issue a high priority, so other packages depending on you could benefit from your bug fixes and new features.

You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can resolve this 💪.

Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.

Once all the errors are resolved, semantic-release will release your package the next time you push a commit to the master branch. You can also manually restart the failed CI job that runs semantic-release.

If you are not sure how to resolve this, here is some links that can help you:

• Usage documentation
• Frequently Asked Questions
• Support channels

If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind semantic-release.

---

No npm token specified.

An npm token must be created and set in the NPM_TOKEN environment variable on your CI environment.

Please make sure to create an npm token and to set it in the NPM_TOKEN environment variable on your CI environment. The token must allow to publish to the registry https://registry.npmjs.org/.

---

Good luck with your project ✨

Your semantic-release bot 📦🚀

Question: Why the type Strings is used in many single string fields ?

Thank you for providing this library, it makes working with Bullhorn APIs easier but I noticed that in many fields like JobOrder["payRate"]

bullhorn-types/src/index.ts

Line 7040 in 8e915b1

salaryUnit?: Strings;

The type Strings is being used to represent a union string | string[] type .
the same applies for the JobOrder["title"] and JobOrder["description"].

is there anywhere in the Rest API documentation / implementation where any of those fields are actually an array of strings string[] ?

Looking at the Entity Reference it looks like the type should be string and there's no mention of the possibility of having string[] anywhere for job titles, descriptions or payRate