Polytomic TypeScript Library

The Polytomic TypeScript library provides convenient access to the Polytomic API from JavaScript/TypeScript.

Documentation

API reference documentation is available here.

Installation

npm install --save polytomic
# or
yarn add polytomic

Usage

import { PolytomicClient, Polytomic } from 'polytomic';

const polytomic = new PolytomicClient({
  token: "YOUR_API_KEY"
});

const bulkSync = polytomic.bulkSync.get("bulk-sync-id");

Request and Response Types

The SDK exports all request and response types as TypeScript interfaces. Simply import them using the Polytomic namespace:

import { Polytomic } from "polytomic"; 

const user: Polytomic.BulkSchedule = {
  frequencey: "hourly"
}

Exception Handling

When the API returns a non-success status code (4xx or 5xx response), a subclass of PolytomicError will be thrown:

import { PolytomicError } from 'polytomic';

try {
  await polytomic.bulkSync.get(...);
} catch (err) {
  if (err instanceof PolytomicError) {
    console.log(err.statusCode); 
    console.log(err.message);
    console.log(err.body); 
  }
}

Retries

The Polytomic TypeScript SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long as the request is deemed retriable and the number of attempts is not larger than the configured limit (default: 2).

A request is deemed retriable when any of the following HTTP status codes is returned:

• 408 (Timeout)
• 409 (Conflict)
• 429 (Too Many Requests)
• 5XX (Internal Server Errors)

Use the maxRetries request option to configure this behavior.

const response = polytomic.bulkSync.get("e7525084....fd94153226fb781", {
  maxRetries: 0 // override maxRetries at the request level
});

Timeouts

The SDK defaults to a 60 second timout. Use the timeoutInSeconds option to configure this behavior.

const response = polytomic.bulkSync.get("e7525084....fd94153226fb781", {
  timeoutInSeconds: 30 // override timeout to 30s
});

Contributing

While we value open-source contributions to this SDK, this library is generated programmatically. Additions made directly to this library would have to be moved over to our generation code, otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we will not be able to merge it as-is.

On the other hand, contributions to the README are always very welcome!