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 🙏

© 2025 – Pkg Stats / Ryan Hefner

@apideck/unify

v0.35.0

Published

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

Downloads

37,115

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

gdewildegdewildenicklloydnicklloydritiksingh7ritiksingh7samzanisamzanilagonilagonijakeprinsjakeprinsgmenoiaagmenoiaa

Keywords

Readme

apideck

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

Summary

Apideck: The Apideck OpenAPI Spec: SDK Optimized

For more information about the API: Apideck Developer Docs

Table of Contents

SDK Installation

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

NPM

npm add @apideck/unify

PNPM

pnpm add @apideck/unify

Bun

bun add @apideck/unify

Yarn

yarn add @apideck/unify

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

import { Apideck } from "@apideck/unify";

const apideck = new Apideck({
  consumerId: "test-consumer",
  appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
  apiKey: process.env["APIDECK_API_KEY"] ?? "",
});

async function run() {
  const result = await apideck.accounting.taxRates.list({
    serviceId: "salesforce",
    filter: {
      assets: true,
      equity: true,
      expenses: true,
      liabilities: true,
      revenue: true,
    },
    passThrough: {
      "search": "San Francisco",
    },
    fields: "id,updated_at",
  });

  for await (const page of result) {
    console.log(page);
  }
}

run();

Available Resources and Operations

accounting.agedCreditors

  • get - Get Aged Creditors

accounting.agedDebtors

  • get - Get Aged Debtors

accounting.attachments

accounting.balanceSheet

  • get - Get BalanceSheet

accounting.bankAccounts

  • list - List Bank Accounts
  • create - Create Bank Account
  • get - Get Bank Account
  • update - Update Bank Account
  • delete - Delete Bank Account

accounting.bankFeedAccounts

  • list - List Bank Feed Accounts
  • create - Create Bank Feed Account
  • get - Get Bank Feed Account
  • update - Update Bank Feed Account
  • delete - Delete Bank Feed Account

accounting.bankFeedStatements

  • list - List Bank Feed Statements
  • create - Create Bank Feed Statement
  • get - Get Bank Feed Statement
  • update - Update Bank Feed Statement
  • delete - Delete Bank Feed Statement

accounting.billPayments

  • list - List Bill Payments
  • create - Create Bill Payment
  • get - Get Bill Payment
  • update - Update Bill Payment
  • delete - Delete Bill Payment

accounting.bills

accounting.categories

  • list - List Categories
  • get - Get Category

accounting.companyInfo

  • get - Get company info

accounting.creditNotes

  • list - List Credit Notes
  • create - Create Credit Note
  • get - Get Credit Note
  • update - Update Credit Note
  • delete - Delete Credit Note

accounting.customers

accounting.departments

accounting.expenses

accounting.invoiceItems

  • list - List Invoice Items
  • create - Create Invoice Item
  • get - Get Invoice Item
  • update - Update Invoice Item
  • delete - Delete Invoice Item

accounting.invoices

accounting.journalEntries

  • list - List Journal Entries
  • create - Create Journal Entry
  • get - Get Journal Entry
  • update - Update Journal Entry
  • delete - Delete Journal Entry

accounting.ledgerAccounts

  • list - List Ledger Accounts
  • create - Create Ledger Account
  • get - Get Ledger Account
  • update - Update Ledger Account
  • delete - Delete Ledger Account

accounting.locations

accounting.payments

accounting.profitAndLoss

  • get - Get Profit and Loss

accounting.projects

accounting.purchaseOrders

  • list - List Purchase Orders
  • create - Create Purchase Order
  • get - Get Purchase Order
  • update - Update Purchase Order
  • delete - Delete Purchase Order

accounting.quotes

accounting.subsidiaries

accounting.suppliers

accounting.taxRates

accounting.trackingCategories

  • list - List Tracking Categories
  • create - Create Tracking Category
  • get - Get Tracking Category
  • update - Update Tracking Category
  • delete - Delete Tracking Category

ats.applicants

ats.applications

  • list - List Applications
  • create - Create Application
  • get - Get Application
  • update - Update Application
  • delete - Delete Application

ats.jobs

connector.apiResourceCoverage

  • get - Get API Resource Coverage

connector.apiResources

  • get - Get API Resource

connector.apis

connector.connectorDocs

  • get - Get Connector Doc content

connector.connectorResources

  • get - Get Connector Resource

connector.connectors

  • list - List Connectors
  • get - Get Connector

crm.activities

crm.companies

crm.contacts

crm.customObjects

  • list - List custom objects
  • create - Create custom object
  • get - Get custom object
  • update - Update custom object
  • delete - Delete custom object

crm.customObjectSchemas

  • list - List custom object schemas
  • create - Create custom object schema
  • get - Get custom object schema
  • update - Update custom object schema
  • delete - Delete custom object schema

crm.leads

crm.notes

crm.opportunities

  • list - List opportunities
  • create - Create opportunity
  • get - Get opportunity
  • update - Update opportunity
  • delete - Delete opportunity

crm.pipelines

crm.users

ecommerce.customers

  • list - List Customers
  • get - Get Customer

ecommerce.orders

ecommerce.products

  • list - List Products
  • get - Get Product

ecommerce.stores

  • get - Get Store

fileStorage.driveGroups

fileStorage.drives

fileStorage.files

fileStorage.folders

fileStorage.sharedLinks

  • list - List SharedLinks
  • create - Create Shared Link
  • get - Get Shared Link
  • update - Update Shared Link
  • delete - Delete Shared Link

fileStorage.uploadSessions

  • create - Start Upload Session
  • get - Get Upload Session
  • upload - Upload part of File to Upload Session
  • delete - Abort Upload Session
  • finish - Finish Upload Session

hris.companies

hris.departments

hris.employeePayrolls

  • list - List Employee Payrolls
  • get - Get Employee Payroll

hris.employees

hris.employeeSchedules

  • list - List Employee Schedules

hris.payrolls

  • list - List Payroll
  • get - Get Payroll

hris.timeOffRequests

  • list - List Time Off Requests
  • create - Create Time Off Request
  • get - Get Time Off Request
  • update - Update Time Off Request
  • delete - Delete Time Off Request

issueTracking.collections

  • list - List Collections
  • get - Get Collection

issueTracking.collectionTags

issueTracking.collectionTicketComments

issueTracking.collectionTickets

issueTracking.collectionUsers

sms.messages

vault.connectionConsent

vault.connectionConsents

  • list - Get consent records

vault.connectionCustomMappings

  • list - List connection custom mappings

vault.connections

  • list - Get all connections
  • get - Get connection
  • update - Update connection
  • delete - Deletes a connection
  • imports - Import connection
  • token - Authorize Access Token

vault.connectionSettings

  • list - Get resource settings
  • update - Update settings

vault.consumerRequestCounts

  • list - Consumer request counts

vault.consumers

vault.createCallback

  • state - Create Callback State

vault.customFields

  • list - Get resource custom fields

vault.customMappings

  • list - List custom mappings

vault.logs

  • list - Get all consumer request logs

vault.sessions

vault.validateConnection

  • state - Validate Connection State

webhook.eventLogs

  • list - List event logs

webhook.webhooks

  • list - List webhook subscriptions
  • create - Create webhook subscription
  • get - Get webhook subscription
  • update - Update webhook subscription
  • delete - Delete webhook subscription

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.

Pagination

Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the returned response object will also be an async iterable that can be consumed using the for await...of syntax.

Here's an example of one such pagination call:

import { Apideck } from "@apideck/unify";

const apideck = new Apideck({
  consumerId: "test-consumer",
  appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
  apiKey: process.env["APIDECK_API_KEY"] ?? "",
});

async function run() {
  const result = await apideck.accounting.taxRates.list({
    serviceId: "salesforce",
    filter: {
      assets: true,
      equity: true,
      expenses: true,
      liabilities: true,
      revenue: true,
    },
    passThrough: {
      "search": "San Francisco",
    },
    fields: "id,updated_at",
  });

  for await (const page of result) {
    console.log(page);
  }
}

run();

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 { Apideck } from "@apideck/unify";
import { openAsBlob } from "node:fs";

const apideck = new Apideck({
  consumerId: "test-consumer",
  appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
  apiKey: process.env["APIDECK_API_KEY"] ?? "",
});

async function run() {
  const result = await apideck.accounting.attachments.upload({
    referenceType: "invoice",
    referenceId: "123456",
    xApideckMetadata:
      "{\"name\":\"document.pdf\",\"description\":\"Invoice attachment\"}",
    serviceId: "salesforce",
    requestBody: await openAsBlob("example.file"),
  });

  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 { Apideck } from "@apideck/unify";

const apideck = new Apideck({
  consumerId: "test-consumer",
  appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
  apiKey: process.env["APIDECK_API_KEY"] ?? "",
});

async function run() {
  const result = await apideck.accounting.taxRates.list({
    serviceId: "salesforce",
    filter: {
      assets: true,
      equity: true,
      expenses: true,
      liabilities: true,
      revenue: true,
    },
    passThrough: {
      "search": "San Francisco",
    },
    fields: "id,updated_at",
  }, {
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });

  for await (const page of result) {
    console.log(page);
  }
}

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 { Apideck } from "@apideck/unify";

const apideck = new Apideck({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
  consumerId: "test-consumer",
  appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
  apiKey: process.env["APIDECK_API_KEY"] ?? "",
});

async function run() {
  const result = await apideck.accounting.taxRates.list({
    serviceId: "salesforce",
    filter: {
      assets: true,
      equity: true,
      expenses: true,
      liabilities: true,
      revenue: true,
    },
    passThrough: {
      "search": "San Francisco",
    },
    fields: "id,updated_at",
  });

  for await (const page of result) {
    console.log(page);
  }
}

run();

Error Handling

ApideckError is the base class for all HTTP error responses. It has the following properties:

| Property | Type | Description | | ------------------------- | ---------- | --------------------------------------------------------------------------------------- | | error.message | string | Error message | | error.httpMeta.response | Response | HTTP response. Access to headers and more. | | error.httpMeta.request | Request | HTTP request. Access to headers and more. | | error.data$ | | Optional. Some errors may contain structured data. See Error Classes. |

Example

import { Apideck } from "@apideck/unify";
import * as errors from "@apideck/unify/models/errors";

const apideck = new Apideck({
  consumerId: "test-consumer",
  appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
  apiKey: process.env["APIDECK_API_KEY"] ?? "",
});

async function run() {
  try {
    const result = await apideck.accounting.taxRates.list({
      serviceId: "salesforce",
      filter: {
        assets: true,
        equity: true,
        expenses: true,
        liabilities: true,
        revenue: true,
      },
      passThrough: {
        "search": "San Francisco",
      },
      fields: "id,updated_at",
    });

    for await (const page of result) {
      console.log(page);
    }
  } catch (error) {
    // The base class for HTTP error responses
    if (error instanceof errors.ApideckError) {
      console.log(error.message);
      console.log(error.httpMeta.response.status);
      console.log(error.httpMeta.response.headers);
      console.log(error.httpMeta.request);

      // Depending on the method different errors may be thrown
      if (error instanceof errors.BadRequestResponse) {
        console.log(error.data$.statusCode); // number
        console.log(error.data$.error); // string
        console.log(error.data$.typeName); // string
        console.log(error.data$.message); // string
        console.log(error.data$.detail); // errors.Detail
      }
    }
  }
}

run();

Error Classes

Primary errors: