Git Product home page Git Product logo

teamwork-api's Introduction

Teamwork Api

A wrapper around teamwork api making it easier to perform requests.

Travis Version Licence

Installation

$ npm install teamwork-api

Getting Started

The api key and sub-domain are required to connect to teamwork's api, provide these as environment variables like so:

process.env.TW_API = '1234567890'
process.env.TW_SUB = 'subdomain'

const tw = require('teamwork-api')()

Alternativly pass them in as function arguments

const tw = require('teamwork-api')('1234567890', 'subdomain')

Contributing

I am happy for people to contribute to this project, fix or add new features.

Be sure when adding / modifying methods that the doc blocks are correct.

The documentation is built based on these comments using npm run docs.

Further to this ensure when you commit you are using npm run commit as this will help when semantic versioning the code.

Happy coding ๐Ÿ’ป...

API Reference

Account

Activity

Invoices

Expenses

Boards

Message Categories

File Categories

Notebook Categories

Link Categories

Clock In / Clock Out

Project Categories

Comments

Calendar Events

Companies

Files

Messages

Milestones

Notebooks

People

Status

Projects

Links

Risks

Time

Task Lists

Tasks

Task Reminders

Tags

Webhooks

Workload

Trashcan

teamwork-api's People

Contributors

moshie avatar alecrios avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.