@gusto/embedded-api

@gusto-embedded/embedded-api

Client SDK responsible for making requests to the Gusto public API.

Getting Started

Install NPM package

npm i @gusto/embedded-api

Usage

import { GustoApi } from '@gusto/embedded-api';

// default value for OpenAPI.BASE is 'https://api.gusto-demo.com'
const config = {
  BASE: 'https://api.gusto-demo.com',
  TOKEN: 'some_session_token',
};

const GustoClient = new GustoApi(OpenAPI);
const payroll = GustoClient.payrolls.getCompanyPayroll({
  companyId,
  payrollId,
});
const employees = GustoClient.employees.getCompanyEmployees({ companyId });

Refreshable Session Token

From Callback

import {
  GustoApi,
  refreshableTokenFromCallback,
  SessionTokenCallbackResponse,
} from '@gusto/gusto-api';

const yourSessionCallback = async (): Promise<SessionTokenCallbackResponse> => {
  return {
    session: 'SESSION',
    expiresIn: 3600,
  };
};
const config = {
  TOKEN: refreshableTokenFromCallback(yourSessionCallback),
};
const GustoClient = new GustoApi(OpenAPI);

From Url

If you pass a url to the refreshableTokenFromCallback function, it will automatically fetch the data from it.

This url should return a json object containing the session and expiresIn properties.

import { GustoApi, refreshableTokenFromCallback } from '@gusto/embedded-api';

const config = {
  TOKEN: refreshableTokenFromCallback('http://url.site.com/gusto/session-token'),
};
const GustoClient = new GustoApi(OpenAPI);

Note: It is your responsibility to properly secure this session-token url !