README.md

RESTyped Staffjoy API

Staffjoy API in TypeScript with type checking for URL endpoints and query params. To learn more about the RESTyped specification, check out the official repo.

How to use it

npm install restyped-staffjoy-api

You'll need a client that supports restyped restyped-axios.

Example

import axios from 'restyped-axios'
import { StaffjoyAPI } from 'restyped-staffjoy-api'

const client = axios.create<StaffjoyAPI>({
   baseURL: 'https://api.tryhabitat.com/api',
   auth: {
      username: process.env.STAFFING_SECRET,
      password: '' //just need jwt secret for auth
   }
})

client.request({
  url: '/attendance',
  params: {
     startDate: 2017-12-15,
     endDate: 2017-12-15
  }
}).then((res) => {
  const { shifts, timeclocks, user_id } = res.data.data[0]
})