npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@fern-api/gusto

v0.1.2

Published

[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://buildwithfern.com/)

Downloads

222

Readme

Gusto TypeScript Library

fern shield

The Gusto TypeScript library provides convenient access to the Gusto API from JavaScript/TypeScript.

Reference

A full reference of the SDK is available here.

Installation

npm install --save @fern-api/gusto
# or
yarn add @fern-api/gusto

Usage

import { GustoClient, Gusto } from 'gusto';

const gusto = new GustoClient({
  auth: {
    type: "token", 
    token: "..." // YOUR_ACCESS_TOKEN
  }
});

await gusto.employee.update("employee_id", {
    version: "db0edd04aaac4506f7edab03ac855d56",
    firstName: "Soren",
    middleInitial: "A",
    lastName: "Kierkegaard",
    dateOfBirth: "1995-05-05",
    email: "[email protected]",
    ssn: "123456294",
    twoPercentShareholder: false,
});

Authentication

System Access Token

The SDK supports authentication using System Access Tokens and automatically refreshing before expiry. See the System Access Token documentation for more details on how to obtain and use System Access Tokens.

const gusto = new GustoClient({
  auth: {
    type: "system_access_token",
    clientId: "YOUR_CLIENT_ID",
    clientSecret: "YOUR_CLIENT_SECRET"
  }
});

Company Access Token

The SDK supports authentication using Company Access Tokens and automatically handles token refresh. See the Company Access Token documentation for more details on how to obtain and use Company Access Tokens. Company Access Tokens allow you to make API calls on behalf of a specific company after completing the OAuth flow.

const gusto = new GustoClient({
  auth: {
    type: "company_access_token",
    clientId: "YOUR_CLIENT_ID", 
    clientSecret: "YOUR_CLIENT_SECRET",
    accessToken: "YOUR_ACCESS_TOKEN",
    refreshToken: "YOUR_REFRESH_TOKEN",
    redirectUri: "YOUR_REDIRECT_URI"
  }
});

Raw Token

If you're managing token acquisition and refresh logic yourself, you can pass in any token directly using the token auth type. This can be used with System Access Tokens or Company Access Tokens, and won't do any sort of refreshing.

const gusto = new GustoClient({
  auth: {
    type: "token",
    token: "YOUR_TOKEN"
  }
});

Request and Response Types

The SDK exports all request and response types as TypeScript interfaces. Simply import them under the Gusto namespace:

import { Gusto } from "gostu"; 

const user: Gusto.PaidTimeOff = {
  name: "Vacation Hours"
  policyName: "...",
}

Exception Handling

When the API returns a non-success status code (4xx or 5xx response), a subclass of GustoError will be thrown:

import { GustoError } from 'gusto';

try {
  await gusto.company.payroll.create(...);
} catch (err) {
  if (err instanceof GustoError) {
    console.log(err.statusCode); 
    console.log(err.message);
    console.log(err.body); 
  }
}

Retries

The TypeScript SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long as the request is deemed retriable and the number of retry attempts has not grown larger than the configured retry limit (default: 2).

A request is deemed retriable when any of the following HTTP status codes is returned:

  • 408 (Timeout)
  • 429 (Too Many Requests)
  • 5XX (Internal Server Errors)

Use the maxRetries request option to configure this behavior.

const response = await gusto.employee.update(..., {
  maxRetries: 0 // override maxRetries at the request level
});

Timeouts

The SDK defaults to a 60 second timout. Use the timeoutInSeconds option to configure this behavior.

const response = await gusto.employee.update(..., {
  timeoutInSeconds: 30 // override timeout to 30s
});

Runtime compatiblity

The SDK defaults to node-fetch but will use the global fetch client if present. The SDK works in the following runtimes:

The following runtimes are supported:

  • Node.js 15+
  • Vercel
  • Cloudflare Workers
  • Deno v1.25+
  • Bun 1.0+
  • React Native

Customizing Fetch client

The SDK provides a way for you to customize the underlying HTTP client / Fetch function. If you're running in an unsupported environment, this provides a way for you to break the glass and ensure the SDK works.

import { GustoClient } from 'gusto';

const gusto = new GustoClient({
  token: "...",
  fetcher: // provide your implementation here
});

Beta status

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning the package version to a specific version in your package.json file. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributing

While we value open-source contributions to this SDK, this library is generated programmatically. Additions made directly to this library would have to be moved over to our generation code, otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we will not be able to merge it as-is.

We suggest opening an issue first to discuss with us!