@typecall/admin-sdk
v0.2.0
Published
JS/TS Admin SDK for Typecall APIs
Readme
@typecall/admin-sdk
Official TypeScript/JavaScript Admin SDK for Typecall.
Note: This open-source SDK provides a client library for interacting with Typecall APIs. To use this SDK, you must have an active Typecall account and administrative API credentials.
Prerequisites
- An active Typecall Account
- An Admin API key generated from the Typecall Dashboard
- Node.js 24+ (or compatible runtimes like Bun, Deno, Cloudflare Workers, or modern browsers)
Features
- Dual Module Output: Native ESM (
import) and CommonJS (require) support. - Strictly Typed: Full TypeScript declarations with sourcemaps included.
- Zero Runtime Dependencies: Built entirely on standard
fetch. - Customizable: Built-in error classes, typed request/response handling, configurable timeouts, custom headers, and custom fetch injection.
Installation
npm install @typecall/admin-sdk
# or
pnpm add @typecall/admin-sdk
# or
yarn add @typecall/admin-sdkQuick Start
import { TypecallAdmin } from "@typecall/admin-sdk";
const client = new TypecallAdmin({
apiKey: process.env.TYPECALL_API_KEY!,
});
// Example request
const org = await client.request<{ id: string; name: string }>("/orgs/me");
console.log(org);Issues & Support
- Client SDK Bugs & Feature Requests: Please open a GitHub issue for issues with the JavaScript/TypeScript client library.
- Platform Inquiries & Account Support: For account access, billing, or platform questions, please contact [email protected].
- Service Status: Check status.typecall.com for real-time API uptime and incident reports.
License
This SDK is distributed under the Apache License, Version 2.0.
Use of the Typecall platform, APIs, and services is governed by the Typecall Terms of Service and Privacy Policy.
