README.md

flowfact - a node.js interface to the Flowfact API

About

Connect to the Flowfact REST API with node.js

Table of contents

• Usage
  • Installation
  • Example
  • API
    • User methods
    • Company methods
  • Tests
• Contribute
• License

Usage

Installation

$ npm install flowfact

In order to authenticate, set the following environment variable

FLOWFACT_URL=flowfact://username:password@contractId

IMPORTANT: Docs are outdated, will soon update

Example

var flowfact = require('flowfact')();

flowfact.getUsers().then(function (userlist) {
	// do something with userlist
)}

API

All methods return promises, handle them accordingly.

User methods

getUsers()

Fetch a list of availible users.

flowfact.getUsers().then(function (userlist) {
	// do something with userlist
}, function (err) {
	// handle error
})

getUser(userId)

Fetch the user with id userId.

flowfact.getUser('176743-B36562A-5254292CF').then(function (user) {
	// do something with user
}, function (err) {
	// handle error
})

getUserContacts(userId)

Fetch a list of contacts for user with id userId.

flowfact.getUserContacts('176743-B36562A-5254292CF').then(function (contacts) {
	// do something with contacts
}, function (err) {
	// handle error
})

getUserActivities(userId)

Fetch a list of activities for user with id userId.

flowfact.getUserActivities('176743-B36562A-5254292CF').then(function (activities) {
	// do something with activities
}, function (err) {
	// handle error
})

Company methods

getCompany()

Fetch company details.

flowfact.getCompany().then(function (company) {
	// do something with company
}, function (err) {
	// handle error
})

getCompanyQuota()

Fetch company quota information.

flowfact.getCompanyQuota().then(function (quota) {
	// do something with quota
}, function (err) {
	// handle error
})

Estate methods

getEstates(userId)

Fetch a list of estates by userId.

flowfact.getEstates('176743-B36562A-5254292CF').then(function (estates) {
	// do something with estate list
}, function (err) {
	// handle error
})

getEstate(userId, estateId)

Fetch details of estate.

flowfact.getEstate('176743-B36562A-5254292CF', '8798ABD-5263474-0773CC3').then(function (estate) {
	// do something with estate
}, function (err) {
	// handle error
})

Tests

Tests are run by mocha. They assume environment variable FLOWFACT_URL to be availible.

$ make test

Contribute

Feel free to fork and pullrequest the hell out of this project :) Make sure all tests pass, or else...

License

The MIT License (MIT)

Copyright (c) 2015 Christian Taepper

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.