Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

timely-client

uplift-ltd62MIT0.3.5TypeScript support: included

Unofficial client for Timely App API.

readme

timely-client

A node.js helper for Timely App API.

Installation

npm install --save timely-client

or

yarn add timely-client

Usage

import TimelyClient from "timely-client";

const client = new TimelyClient({
  accessToken: "abc123",
  apiUrl: "https://api.timelyapp.com/1.1", // <- defaults to this
});

const { data: accounts } = await client.getAccounts();

For a full list of methods check out the code.

All methods return a promise that resolve to a response-like object that looks like this:

{
  status: 200,
  statusText: 'OK',
  ok: true,
  data: [{ ... }]
}

Note: The client does not help with the OAuth flow. It expects an access token only. PRs welcome.

License

Copyright (c) 2018 Marius Craciunoiu. Licensed under the MIT license.