TypeScript SDK

IntroCopy Anchor Link

The Swyfft Partner API SDK provides access to the Swyfft Partner API REST APIs.

Partner API for homeowners (HO) quoting: rate Admitted and E&S carriers for a property address in one call, then adjust coverage elements on the returned quotes.

InstallationCopy Anchor Link

The SDK compiles to dist/ before it can be referenced — run its build script once in the SDK folder, then add it to your project by path:

npm install <path-to-sdk>

Quick StartCopy Anchor Link

Create one client and reuse it. Configure its behaviour through ClientOptions.

import { ServerEnvironment, SwyfftPartnerApiClient } from "swyfft-partner-api";

const client = new SwyfftPartnerApiClient({
  serverEnvironment: ServerEnvironment.Production,
  partnerApiKey: "YOUR_API_KEY",
  partnerApiIntermediaryKey: "YOUR_API_KEY",
});

Nothing in ClientOptions is required — new SwyfftPartnerApiClient() compiles — and each option left out falls back to its default. serverEnvironment is spelled out above so the environment a call reaches is visible where the client is built rather than inherited silently.

From CommonJSCopy Anchor Link

The package ships both dialects from a single entry, so require works with full types. In a TypeScript CommonJS file use the import ... = require(...) form — a plain destructuring require runs fine but gives you any.

import sdk = require("swyfft-partner-api");

const client = new sdk.SwyfftPartnerApiClient({
  serverEnvironment: sdk.ServerEnvironment.Production,
  partnerApiKey: "YOUR_API_KEY",
  partnerApiIntermediaryKey: "YOUR_API_KEY",
});