TypeScript SDK

The TypeScript client is @parable-platform/web-api-sdk. It covers every endpoint in the API Reference.

Your Parable representative will confirm registry access if the package is not public yet.

Install

npm install @parable-platform/web-api-sdk @parable-platform/web-api-types

Import and authenticate

Create a client with your workspace API token. See Authentication if you do not have one.

import { WebApiSDK } from "@parable-platform/web-api-sdk";

const token = process.env.PARABLE_API_TOKEN;
if (!token) {
  throw new Error("Set PARABLE_API_TOKEN");
}

const sdk = new WebApiSDK({
  baseUrl: "https://api.askparable.com",
  auth: { token },
});

The client sends Authorization: Bearer ... on every call.

Read

Who you are, then the connectors configured in your workspace:

const me = await sdk.users.me();
console.log(me.name, me.email);

const connectors = await sdk.vendors.tenantConnectorInstances();
for (const connector of connectors) {
  console.log(connector.name, connector.connectionStatus);
}

Update

Enable a tap. Replace the id with one from your workspace. List taps with sdk.tenantConnectorTaps.tenantConnectorTaps().

const tap = await sdk.tenantConnectorTaps.updateTenantConnectorTap(
  "018f2a3b-9c4d-7e5f-8a6b-1c2d3e4f5a6b",
  { enabled: true },
);

console.log(tap.id, tap.enabled);

Omitted fields are left unchanged. To disable the tap, pass { enabled: false }.

This SDK maps directly to API names. Groups in the API Reference are namespaces (sdk.users, sdk.vendors); operation names are methods (me, tenantConnectorInstances). If an endpoint is in that spec, it is on this client.

Getting Started

SDKs

Connectors

Parable Data Engine

Install

Import and authenticate

Read

Update

​Install

​Import and authenticate

​Read

​Update

Install

Import and authenticate

Read

Update