Skip to content

ProminentEdge/node-tsheetsapi

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

31 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

node-tsheetsapi

(Unofficial) Simple TSheets node.js API Helper.

Features:

  • Support Bearer Token authentication
  • Supports pagination
  • Supports supplemental data
  • List / Add / Update or Delete on (almost) any endpoint
  • Based on async/await

Supported endpoints

  • /users
  • /groups
  • /jobcodes
  • /jobcode_assignments
  • /timesheets
  • /timesheets_deleted
  • /geolocations
  • /reports
  • /last_modfied
  • /notifications
  • /reminders
  • /schedule_calendars
  • /schedule_events
  • /managed_clients

Install

npm install tsheetsapi --save

Basic Usage

All the endpoints are named exactly like in the TSheets docs.

The .add() and .update() methods need a data field in the parameters object:

{
  "data" : [{}, {}, ...]
}

Instead, the .list() and .delete() methods do not require a data field, you can just specify your parameters right away.

Authentication

const TSheetsApi = require('tsheetsapi');

const tapi = new TSheetsApi({
        	bearerToken : '<your-access-token>'
           });

Paginate through all users

let res = await tapi.users().list();

while(res && res.data.length){
  
  console.log(res.data)
  console.log(res.supplemental_data)
  await res = res.next; 
    
}

List jobcodes

let res = await tapi.jobcodes().list()
console.log(res.data);

Add schedule event

const params = {
  data : [{
        schedule_calendar_id : '<your-id>',
        start : '2017-06-12T15:19:21+00:00',
        end   : '2017-06-13T15:19:21+00:00',
        all_day : true
  }]
};

let res = await tapi.schedule_events.add(params);
console.log(res.data);

About

(Unofficial) Simple TSheets node.js API Helper

Resources

License

Stars

Watchers

Forks

Packages

No packages published