Skip to content

Latest commit

 

History

History
70 lines (48 loc) · 1.94 KB

File metadata and controls

70 lines (48 loc) · 1.94 KB

ThreadSync Node.js SDK

npm license

Official Node.js / TypeScript SDK for the ThreadSync API.

Installation

Preview: SDKs are in preview and installed from GitHub. Registry packages (npm, PyPI, etc.) will be available at GA.

npm i github:threadsync-infrastructure/threadsync-node

Quick Start

import { ThreadSync } from '@threadsync/sdk';

const client = new ThreadSync({ bearerToken: 'YOUR_API_KEY' });

// Create a connection
const connection = await client.connections.create('salesforce', {
  credentials: { username: 'user@example.com', password: 'secret' }
});

// Set up a sync
const sync = await client.sync.create({
  source: { connection: connection.id, object: 'Contact' },
  destination: { connection: 'dest-conn-id', table: 'contacts' },
  schedule: 'realtime',
});

console.log(`Sync started: ${sync.id}`);

API Reference

new ThreadSync(config)

Option Type Required Description
bearerToken string Yes Your ThreadSync API key
baseUrl string No Override the API base URL (default: https://api.threadsync.io/v1)

client.connections

Method Description
connections.create(provider, options?) Create a new connection
connections.get(id) Retrieve a connection by ID
connections.list() List all connections

client.sync

Method Description
sync.create(config) Create a new sync job
sync.get(id) Retrieve a sync by ID
sync.list() List all syncs

Links

License

MIT — see LICENSE