TypeScript SDK

IntroCopy Anchor Link

The InCountry REST API SDK provides access to the InCountry REST API REST APIs.

Store, query and manage regulated data in the InCountry Data Residency-as-a-Service (DRaaS) vault of a specific country.

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 { InCountryRestApiClient, ServerEnvironment } from "in-country-rest-api";

const client = new InCountryRestApiClient({
  serverEnvironment: ServerEnvironment.Production,
  bearerAuth: "YOUR_BEARER_TOKEN",
  clientBasicAuth: { username: "YOUR_USERNAME", password: "YOUR_PASSWORD" },
});

Nothing in ClientOptions is required — new InCountryRestApiClient() 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("in-country-rest-api");

const client = new sdk.InCountryRestApiClient({
  serverEnvironment: sdk.ServerEnvironment.Production,
  bearerAuth: "YOUR_BEARER_TOKEN",
  clientBasicAuth: { username: "YOUR_USERNAME", password: "YOUR_PASSWORD" },
});