@fern-api/gappify v0.0.6

Gappify Node Library

The Gappify Node.js library provides access to the Gappify API from JavaScript/TypeScript.

Documentation

API reference documentation is available at gappify.docs.buildwithfern.com

Installation

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

Usage

import { GappifyClient } from "@fern-api/gappify";

const gappify = new GappifyClient({
  // This is usually the environment specific "Secret Key" that can be found
  // on the Getting Started page in the Flatfile dashboard.
  apiKey: 'YOUR_API_KEY',
});

const vendor = await gappify.vendor.get("vendor_1230..");

Handling errors

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

import { GappifyError } from "@fern-api/gappify";

try {
  await gappify.vendor.get("vendor_1230..");
} catch (err) {
  if (err instanceof GappifyError) {
    console.log(err.statusCode);
    console.log(err.message);
    console.log(err.body);
  }
}

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!

On the other hand, contributions to the README are always very welcome!