TypeScript SDK - Parable

The TypeScript client is @parable-platform/web-api-sdk. It covers the endpoints in the Workspace API reference.

Access

The TypeScript SDK is not publicly distributed yet. Contact your Parable representative for access.

Import and authenticate

Create a client with the Workspace API base URL and your token.

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

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

const sdk = new WebApiSDK({
  baseUrl,
  auth: { token },
});

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

Query Workspace data

There is no published TypeScript Flight SQL client. For table data rather than control-plane resources, use one of the Python, Go, or Rust clients in the SQL SDK guide, which shows how to execute a query and decode its Arrow result. The SQL primer defines the shared catalog and pool model.

Read

Read the current member, then the Provider connections configured in the Workspace:

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

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

Update

Enable a tap. Replace the ID with one from the 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 }.

Groups in the Workspace API reference are namespaces such as sdk.users and sdk.vendors. Operations are methods such as me and tenantConnectorInstances.

Admin

​Access

​Import and authenticate

​Query Workspace data

​Read

​Update

Access

Import and authenticate

Query Workspace data

Read

Update