Skip to content

piotrekwitkowski/quip-api-typescript

Repository files navigation

quip-api-typescript

codecov npm version

This is the unofficial Node.js library to access the Quip Automation API.

Notice

This library should be considered as Work In Progress. The official quip-api library wasn't updated recently and isn't maintained anymore, so I created this one that is more convenient to use thanks to typings and promises.

Installation

npm i quip-api-typescript

Usage

For now, the library supports only access token auth (no OAuth).

import { QuipClient } from 'quip-api-typescript';

const ACCESS_TOKEN = 'your-access-token';
const client = new QuipClient(ACCESS_TOKEN);

// use like this
client.threads.getThreadHtmlV2({ id: '' }).then(response => doSomething(response));

// or this
client.users.getUser({ id: 'john@acme.com' }).then(response => doSomething(response));

Documentation

More methods, request and response types can be found in the documentation.

Official Quip API Docs

Contributing

PRs are welcome! Please feel encouraged to star this repo too!