🚀 Big News: Socket Acquires Coana to Bring Reachability Analysis to Every Appsec Team.Learn more →
Socket
DemoInstallSign in
Socket
DemoInstallSign in

@gusto/embedded-api

Package Overview
Dependencies
Maintainers
1
Versions
24
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@gusto/embedded-api

Developer-friendly & type-safe Typescript SDK specifically catered to leverage *gusto-embedded* API.

0.5.13
latest
Source
npm
Version published
Weekly downloads
168
-56.36%
Maintainers
1
Weekly downloads
 
Created
Source

gusto-embedded

Developer-friendly & type-safe Typescript SDK specifically catered to leverage gusto-embedded API.



[!IMPORTANT] This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your workspace. Delete this section before > publishing to a package manager.

Summary

Gusto API: Welcome to Gusto's Embedded Payroll API documentation!

Table of Contents

SDK Installation

The SDK can be installed with either npm, pnpm, bun or yarn package managers.

NPM

npm add @gusto/embedded-api
# Install optional peer dependencies if you plan to use React hooks
npm add @tanstack/react-query react react-dom

PNPM

pnpm add @gusto/embedded-api
# Install optional peer dependencies if you plan to use React hooks
pnpm add @tanstack/react-query react react-dom

Bun

bun add @gusto/embedded-api
# Install optional peer dependencies if you plan to use React hooks
bun add @tanstack/react-query react react-dom

Yarn

yarn add @gusto/embedded-api zod
# Install optional peer dependencies if you plan to use React hooks
yarn add @tanstack/react-query react react-dom

# Note that Yarn does not install peer dependencies automatically. You will need
# to install zod as shown above.

[!NOTE] This package is published as an ES Module (ESM) only. For applications using CommonJS, use await import("@gusto/embedded-api") to import and use this package.

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

import { GustoEmbedded } from "@gusto/embedded-api";

const gustoEmbedded = new GustoEmbedded({
  companyAccessAuth: process.env["GUSTOEMBEDDED_COMPANY_ACCESS_AUTH"] ?? "",
});

async function run() {
  const result = await gustoEmbedded.introspection.getInfo({});

  // Handle the result
  console.log(result);
}

run();

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

NameTypeSchemeEnvironment Variable
companyAccessAuthhttpHTTP BearerGUSTOEMBEDDED_COMPANY_ACCESS_AUTH

To authenticate with the API the companyAccessAuth parameter must be set when initializing the SDK client instance. For example:

import { GustoEmbedded } from "@gusto/embedded-api";

const gustoEmbedded = new GustoEmbedded({
  companyAccessAuth: process.env["GUSTOEMBEDDED_COMPANY_ACCESS_AUTH"] ?? "",
});

async function run() {
  const result = await gustoEmbedded.introspection.getInfo({});

  // Handle the result
  console.log(result);
}

run();

Per-Operation Security Schemes

Some operations in this SDK require the security scheme to be specified at the request level. For example:

import { GustoEmbedded } from "@gusto/embedded-api";

const gustoEmbedded = new GustoEmbedded();

async function run() {
  const result = await gustoEmbedded.companies.createPartnerManaged({
    systemAccessAuth: process.env["GUSTOEMBEDDED_SYSTEM_ACCESS_AUTH"] ?? "",
  }, {
    requestBody: {
      user: {
        firstName: "Frank",
        lastName: "Ocean",
        email: "frank@example.com",
        phone: "2345558899",
      },
      company: {
        name: "Frank's Ocean, LLC",
        tradeName: "Frank’s Ocean",
        ein: "123456789",
        contractorOnly: false,
      },
    },
  });

  // Handle the result
  console.log(result);
}

run();

Available Resources and Operations

Available methods

achTransactions

  • getAll - Get all ACH transactions for a company

bankAccounts

  • create - Create a company bank account
  • get - Get all company bank accounts
  • verify - Verify a company bank account
  • createFromPlaidToken - Create a bank account from a plaid processor token

companies

companies.suspensions

  • get - Get suspensions for this company
  • suspend - Suspend a company's account

companyAttachment

  • getDownloadUrl - Get a temporary url to download the Company Attachment file

companyAttachments

  • getDetails - Get Company Attachment Details
  • getList - Get List of Company Attachments
  • create - Create Company Attachment and Upload File

companyBenefits

companyForms

  • getAll - Get all company forms
  • get - Get a company form
  • getPdf - Get a company form pdf
  • sign - Sign a company form

contractorDocuments

  • getAll - Get all contractor documents
  • get - Get a contractor document
  • getPdf - Get the contractor document pdf
  • sign - Sign a contractor document

contractorForms

  • list - Get all contractor forms
  • get - Get a contractor form
  • getPdf - Get the contractor form pdf
  • generate1099 - Generate a 1099 form [DEMO]

contractorPaymentGroups

  • create - Create a contractor payment group
  • getList - Get contractor payment groups for a company
  • preview - Preview a contractor payment group
  • get - Fetch a contractor payment group
  • delete - Cancel a contractor payment group
  • fund - Fund a contractor payment group [DEMO]

contractorPaymentMethod

  • getBankAccounts - Get all contractor bank accounts
  • get - Get a contractor's payment method
  • update - Update a contractor's payment method

contractorPaymentMethods

contractorPayments

  • getReceipt - Get a single contractor payment receipt
  • fund - Fund a contractor payment [DEMO]
  • create - Create a contractor payment
  • list - Get contractor payments for a company
  • get - Get a single contractor payment
  • delete - Cancel a contractor payment

contractors

departments

earningTypes

  • create - Create a custom earning type
  • list - Get all earning types for a company
  • update - Update an earning type
  • delete - Deactivate an earning type

employeeAddresses

employeeBenefits

employeeEmployments

employeeForms

  • generateW2 - Generate a W2 form [DEMO]
  • list - Get all employee forms
  • get - Get an employee form
  • getPdf - Get the employee form pdf
  • sign - Sign an employee form

employeePaymentMethod

employeePaymentMethods

employees

employeeTaxSetup

events

  • get - Get all events

externalPayrolls

federalTaxDetails

  • get - Get Federal Tax Details
  • update - Update Federal Tax Details

flows

garnishments

generatedDocuments

  • get - Get a generated document

historicalEmployees

  • update - Update a historical employee

holidayPayPolicies

  • get - Get a company's holiday pay policy
  • create - Create a holiday pay policy for a company
  • update - Update a company's holiday pay policy
  • delete - Delete a company's holiday pay policy
  • addEmployees - Add employees to a company's holiday pay policy
  • removeEmployees - Remove employees from a company's holiday pay policy

i9Verification

industrySelection

  • get - Get a company industry selection
  • update - Update a company industry selection

informationRequests

introspection

invoices

  • get - Retrieve invoicing data for companies

jobsAndCompensations

locations

notifications

paymentConfigs

  • get - Get a company's payment configs
  • update - Update a company's payment configs

payrolls

paySchedules

recoveryCases

  • get - Get all recovery cases for a company
  • redebit - Initiate a redebit for a recovery case

reports

signatories

  • create - Create a signatory
  • list - Get all company signatories
  • invite - Invite a signatory
  • update - Update a signatory
  • delete - Delete a signatory

taxRequirements

  • get - Get State Tax Requirements
  • updateState - Update State Tax Requirements
  • getAll - Get All Tax Requirement States

timeOffPolicies

webhooks

wireInRequests

  • get - Get a single Wire In Request
  • submit - Submit a wire in request
  • list - Get all Wire In Requests for a company

Standalone functions

All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.

To read more about standalone functions, check FUNCTIONS.md.

Available standalone functions

React hooks with TanStack Query

React hooks built on TanStack Query are included in this SDK. These hooks and the utility functions provided alongside them can be used to build rich applications that pull data from the API using one of the most popular asynchronous state management library.

To learn about this feature and how to get started, check REACT_QUERY.md.

[!WARNING]

This feature is currently in preview and is subject to breaking changes within the current major version of the SDK as we gather user feedback on it.

Available React hooks

File uploads

Certain SDK methods accept files as part of a multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.

[!TIP]

Depending on your JavaScript runtime, there are convenient utilities that return a handle to a file without reading the entire contents into memory:

  • Node.js v20+: Since v20, Node.js comes with a native openAsBlob function in node:fs.
  • Bun: The native Bun.file function produces a file handle that can be used for streaming file uploads.
  • Browsers: All supported browsers return an instance to a File when reading the value from an <input type="file"> element.
  • Node.js v18: A file stream can be created using the fileFrom helper from fetch-blob/from.js.
import { GustoEmbedded } from "@gusto/embedded-api";
import { openAsBlob } from "node:fs";

const gustoEmbedded = new GustoEmbedded({
  companyAccessAuth: process.env["GUSTOEMBEDDED_COMPANY_ACCESS_AUTH"] ?? "",
});

async function run() {
  const result = await gustoEmbedded.companyAttachments.create({
    companyId: "<id>",
    requestBody: {
      document: await openAsBlob("example.file"),
      category: "gep_notice",
    },
  });

  // Handle the result
  console.log(result);
}

run();

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:

import { GustoEmbedded } from "@gusto/embedded-api";

const gustoEmbedded = new GustoEmbedded({
  companyAccessAuth: process.env["GUSTOEMBEDDED_COMPANY_ACCESS_AUTH"] ?? "",
});

async function run() {
  const result = await gustoEmbedded.introspection.getInfo({}, {
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });

  // Handle the result
  console.log(result);
}

run();

If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:

import { GustoEmbedded } from "@gusto/embedded-api";

const gustoEmbedded = new GustoEmbedded({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
  companyAccessAuth: process.env["GUSTOEMBEDDED_COMPANY_ACCESS_AUTH"] ?? "",
});

async function run() {
  const result = await gustoEmbedded.introspection.getInfo({});

  // Handle the result
  console.log(result);
}

run();

Error Handling

Some methods specify known errors which can be thrown. All the known errors are enumerated in the models/errors/errors.ts module. The known errors for a method are documented under the Errors tables in SDK docs. For example, the createPartnerManaged method may throw the following errors:

Error TypeStatus CodeContent Type
errors.UnprocessableEntityErrorObject422application/json
errors.APIError4XX, 5XX*/*

If the method throws an error and it is not captured by the known errors, it will default to throwing a APIError.

import { GustoEmbedded } from "@gusto/embedded-api";
import { SDKValidationError } from "@gusto/embedded-api/models/errors/sdkvalidationerror.js";
import { UnprocessableEntityErrorObject } from "@gusto/embedded-api/models/errors/unprocessableentityerrorobject.js";

const gustoEmbedded = new GustoEmbedded();

async function run() {
  let result;
  try {
    result = await gustoEmbedded.companies.createPartnerManaged({
      systemAccessAuth: process.env["GUSTOEMBEDDED_SYSTEM_ACCESS_AUTH"] ?? "",
    }, {
      requestBody: {
        user: {
          firstName: "Frank",
          lastName: "Ocean",
          email: "frank@example.com",
          phone: "2345558899",
        },
        company: {
          name: "Frank's Ocean, LLC",
          tradeName: "Frank’s Ocean",
          ein: "123456789",
          contractorOnly: false,
        },
      },
    });

    // Handle the result
    console.log(result);
  } catch (err) {
    switch (true) {
      // The server response does not match the expected SDK schema
      case (err instanceof SDKValidationError): {
        // Pretty-print will provide a human-readable multi-line error message
        console.error(err.pretty());
        // Raw value may also be inspected
        console.error(err.rawValue);
        return;
      }
      case (err instanceof UnprocessableEntityErrorObject): {
        // Handle err.data$: UnprocessableEntityErrorObjectData
        console.error(err);
        return;
      }
      default: {
        // Other errors such as network errors, see HTTPClientErrors for more details
        throw err;
      }
    }
  }
}

run();

Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The SDKValidationError that is thrown as a result will capture the raw value that failed validation in an attribute called rawValue. Additionally, a pretty() method is available on this error that can be used to log a nicely formatted multi-line string since validation errors can list many issues and the plain error string may be difficult read when debugging.

In some rare cases, the SDK can fail to get a response from the server or even make the request due to unexpected circumstances such as network conditions. These types of errors are captured in the models/errors/httpclienterrors.ts module:

HTTP Client ErrorDescription
RequestAbortedErrorHTTP request was aborted by the client
RequestTimeoutErrorHTTP request timed out due to an AbortSignal signal
ConnectionErrorHTTP client was unable to make a request to a server
InvalidRequestErrorAny input used to create a request is invalid
UnexpectedClientErrorUnrecognised or unexpected error

Server Selection

Select Server by Name

You can override the default server globally by passing a server name to the server: keyof typeof ServerList optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the names associated with the available servers:

NameServerDescription
demohttps://api.gusto-demo.comDemo
prodhttps://api.gusto.comProd

Example

import { GustoEmbedded } from "@gusto/embedded-api";

const gustoEmbedded = new GustoEmbedded({
  server: "prod",
  companyAccessAuth: process.env["GUSTOEMBEDDED_COMPANY_ACCESS_AUTH"] ?? "",
});

async function run() {
  const result = await gustoEmbedded.introspection.getInfo({});

  // Handle the result
  console.log(result);
}

run();

Override Server URL Per-Client

The default server can also be overridden globally by passing a URL to the serverURL: string optional parameter when initializing the SDK client instance. For example:

import { GustoEmbedded } from "@gusto/embedded-api";

const gustoEmbedded = new GustoEmbedded({
  serverURL: "https://api.gusto-demo.com",
  companyAccessAuth: process.env["GUSTOEMBEDDED_COMPANY_ACCESS_AUTH"] ?? "",
});

async function run() {
  const result = await gustoEmbedded.introspection.getInfo({});

  // Handle the result
  console.log(result);
}

run();

Custom HTTP Client

The TypeScript SDK makes API calls using an HTTPClient that wraps the native Fetch API. This client is a thin wrapper around fetch and provides the ability to attach hooks around the request lifecycle that can be used to modify the request or handle errors and response.

The HTTPClient constructor takes an optional fetcher argument that can be used to integrate a third-party HTTP client or when writing tests to mock out the HTTP client and feed in fixtures.

The following example shows how to use the "beforeRequest" hook to to add a custom header and a timeout to requests and how to use the "requestError" hook to log errors:

import { GustoEmbedded } from "@gusto/embedded-api";
import { HTTPClient } from "@gusto/embedded-api/lib/http";

const httpClient = new HTTPClient({
  // fetcher takes a function that has the same signature as native `fetch`.
  fetcher: (request) => {
    return fetch(request);
  }
});

httpClient.addHook("beforeRequest", (request) => {
  const nextRequest = new Request(request, {
    signal: request.signal || AbortSignal.timeout(5000)
  });

  nextRequest.headers.set("x-custom-header", "custom value");

  return nextRequest;
});

httpClient.addHook("requestError", (error, request) => {
  console.group("Request Error");
  console.log("Reason:", `${error}`);
  console.log("Endpoint:", `${request.method} ${request.url}`);
  console.groupEnd();
});

const sdk = new GustoEmbedded({ httpClient });

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass a logger that matches console's interface as an SDK option.

[!WARNING] Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.

import { GustoEmbedded } from "@gusto/embedded-api";

const sdk = new GustoEmbedded({ debugLogger: console });

You can also enable a default debug logger by setting an environment variable GUSTOEMBEDDED_DEBUG to true.

Development

Maturity

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

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

SDK Created by Speakeasy

FAQs

Package last updated on 08 May 2025

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

Secure Your AI-Generated Code with Socket MCP

Product

Secure Your AI-Generated Code with Socket MCP

Socket MCP brings real-time security checks to AI-generated code, helping developers catch risky dependencies before they enter the codebase.

By Alexandros Kapravelos  -  May 28, 2025