node-tonic v0.3.0

Node Tonic

A Tonic API wrapper for Node.js

Usage

Installation

npm install node-tonic or yarn add node-tonic

Creating a client

import Tonic from 'node-tonic';

const tonic = new Tonic({
  apiKey: 'XXXXXXXX', // your API key
  basePath: 'https://base-tonic-url', // base api url
});

Types

The types are automatically generated from the REST API docs using openapi-typescript package. You can regenerate types by running

npm run generate:types

API

Here is a list of all the Tonic.ai API endpoints along with the corresponding library method. We have not yet implemented all the endpoints in the Tonic REST API. If an endpoint you need is missing please consider submitting a pull request. Reference for the endpoints is available in the API docs.

Contributing

Development

1. Clone this repo
2. npm install
3. Build package with npm run build or turn on watch mode with npm run watch

Testing

npm run test

Building

npm run build

If you need to clear the build cache run npm run clean

Publishing

1. Update the version in package.json
2. Add a CHANGELOG entry
3. Add reference for new method(s) in this file in the API section
4. Commit your changes
5. Run npm pack --dry-run to see what will be published
6. Run npm publish