TypeScript SDK

@outflare/sdk is a small typed client for the Outflare API. Its types are generated from api/openapi.yaml, so every path, parameter and response is checked by the TypeScript compiler, and CI keeps it in step with the server. It is licensed Apache-2.0, so you can embed it in closed-source tools without copyleft obligations.

Not on npm The package is not published to a registry yet. Build it from the repository:

git clone https://github.com/outflareai/outflare
cd outflare && pnpm install && pnpm --filter @outflare/sdk build
# then, in your project:
npm install /path/to/outflare/sdk/ts

Usage

import { readFile } from 'node:fs/promises';
import { createClient } from '@outflare/sdk';

const gtm = createClient({
  baseUrl: 'https://outflare.example.com',
  token: process.env.OUTFLARE_TOKEN, // oft_...
});

const ws = process.env.OUTFLARE_WORKSPACE!;

// List active mailboxes
const { data, error } = await gtm.GET('/v1/workspaces/{ws}/mailboxes', {
  params: { path: { ws }, query: { status: 'active' } },
});
if (error) throw new Error(error.error.message);
for (const m of data.data) console.log(m.email, m.daily_limit);

// Import a reseller CSV into a pool
const csv = await readFile('mailboxes.csv', 'utf8');
const res = await gtm.POST('/v1/workspaces/{ws}/mailboxes/import', {
  params: { path: { ws }, query: { pool: 'Warm' } },
  body: csv,
  headers: { 'Content-Type': 'text/csv' },
  bodySerializer: (b: string) => b,
});
console.log(res.data); // { created, updated, errors }

The client is built on openapi-fetch. Every call returns { data, error, response } instead of throwing, and error has the API’s error shape.

Throwing on errors with ok()

Scripts and agents usually want a call to either succeed or stop. Wrap it in ok(): it returns data, or throws an OutflareError with the HTTP status, the API’s error code (such as conflict or invalid_request), the message and the requestId.

import { createClient, ok, OutflareError } from '@outflare/sdk';

const stats = ok(await gtm.GET('/v1/workspaces/{ws}/stats', { params: { path: { ws } } }));
console.log(`${stats.sent_24h} sent today of ${stats.mailboxes.daily_capacity}, ${stats.unread_replies} unread replies`);

try {
  ok(await gtm.DELETE('/v1/workspaces/{ws}/oauth-connections/{id}', { params: { path: { ws, id } } }));
} catch (e) {
  if (e instanceof OutflareError && e.code === 'conflict') console.log(e.message); // mailboxes still use it
  else throw e;
}

Options

Option	Description
baseUrl	Your instance, for example https://outflare.example.com. Leave empty for same-origin, as the web app does.
token	An API token. Omit it in the browser to use the signed-in session cookie.
fetch	A custom fetch implementation, for tests or older runtimes.

Types

Common schemas are exported as types, including Workspace, WorkspaceStats, Member, APIToken, Mailbox, OAuthConnection, ImportResult, Lead, LeadList, Suppression, Sequence, Step, Enrollment, Message, InboundMessage, ThreadEntry, Meta and ApiError. The full generated paths and components types are exported too.

Other languages

Generate a client from your instance’s /v1/openapi.yaml with any OpenAPI 3.1 generator, such as openapi-generator for Python, Go or Java.