Skip to navigation

TypeScript

Bridge provides a TypeScript client for interacting with the Bridge API. This SDK simplifies API integration by providing type-safe methods, automatic authentication handling, and built-in error handling.

Features

  • Type Safety: Full TypeScript support with generated types from our API specification
  • Authentication: Automatic token management and refresh handling
  • Error Handling: Comprehensive error handling with detailed error messages
  • Request/Response Validation: Built-in validation for all API requests and responses
  • Modern JavaScript: ES6+ features with async/await support

Installation

Install the SDK from npm:

npm install @usebridge/api

Or using yarn:

yarn add @usebridge/api

Quick Start

import { BridgeApiClient, BridgeApiEnvironment } from "@usebridge/api"
// Initialize the client
const client = new BridgeApiClient({
apiKey: "your-api-key",
environment: BridgeApiEnvironment.Production, // or BridgeApiEnvironment.Sandbox (defaults to BridgeApiEnvironment.Production if not specified)
})
// Create a Patient
const patient = await client.patients.v2.createPatient({
firstName: "Jane",
lastName: "Smith",
email: "patient@example.com",
dateOfBirth: "2000-01-01",
})

Resources