Node wrapper around the Tickspot API
JavaScript
Switch branches/tags
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
test
.gitignore
.npmignore
LICENSE
README.md
bitbucket-pipelines.yml
package.json

README.md

tickspot-api

A Node module wrapping the Tickspot API.

Installation

npm install tickspot-api

Usage

All calls to Tickspot's API are made over HTTPS.

var Tickspot = require('tickspot-api');

var ts = new Tickspot('yourcompany', 'your@email', 'yourpassword');

Every method can use either the Node.js callback pattern, and/or use the promise returned by the method. The next two examples are equivalent.

ts.recentTasks(function (error, tasks) {
    if (!error) {
        console.log(tasks); // Print the array of recent tasks
    }
});
ts.recentTasks().then(function (tasks) {
    console.log(tasks); // Print the array of recent tasks
});

Methods

There is an equivalent method for every endpoint listed at the Tickspot API.

  • clients([options], [callback])
  • projects([options], [callback])
  • tasks(project_id, [options], [callback])
  • clientsProjectsTasks([callback])
  • entries(start_date, [end_date], [options], [callback])
  • recentTasks([callback])
  • users([options], [callback])
  • createEntry(task_id, hours, date, [options], [callback])
  • updateEntry(id, [options], [callback])