TypeScript SDK

A thin typed client over the same REST surface: retries, pagination helpers and webhook verification in one import.

Version v1 · updated 2026-02-01

The SDK adds types, retry and pagination over `fetch`. It adds no behaviour the REST API does not have — anything you can do with the client you can do with curl, which is deliberate: your production integration should never depend on a feature only one client implements.

npm install @framique/sdk

import { Framique } from "@framique/sdk";

const fq = new Framique({
  apiKey: process.env.FRAMIQUE_API_KEY!,
  // Both default to sane values; shown here because production should set them.
  timeoutMs: 10_000,
  maxRetries: 5,
});

// Cursor pagination as an async iterator — no manual cursor bookkeeping.
for await (const order of fq.orders.list({ status: "paid" })) {
  await warehouse.enqueue(order.id);
}

// Writes take an idempotency key; omit it and the SDK generates a UUID per call.
await fq.orders.addNote(orderId, { body: "Picked", idempotencyKey: jobId });