Skip to content

pliancy/timelyapp-sdk

Repository files navigation

TimelyApp Node SDK

Timely Rest API GitHub Workflow Status npm Downloads Dependency Status License

A typed node module which provides a wrapper and several convienence functions for the TimelyApp.com API

Installation

npm install timelyapp

Examples

import { TimelyApp } from 'timelyapp'
import dotenv from 'dotenv'
dotenv.config()

const timely = new TimelyApp({
    accountId: process.env.TIMELY_ACCOUNT as string,
    token: process.env.TIMELY_TOKEN as string,
})

;(async () => {
    const output = await timely.getClients()
    // eslint-disable-next-line no-console
    console.dir(output, { depth: null })
    // eslint-disable-next-line no-console
})().catch(console.log)

Create the client

import { TimelyApp } from 'timelyapp'

const timely = new TimelyApp({
  clientId: 'xxxxxxxxxxxxx',
  clientSecret: 'xxxxxxxxxxxxx',
  accountId: '123456',
})

Get all users

const users = await timely.users.getAll()