Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

    tickspot-apipublic

    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])

    install

    npm i tickspot-api

    Downloadslast 7 days

    1

    version

    0.2.1

    license

    MIT

    repository

    github.com

    last publish

    collaborators

    • avatar