Onfleet node.js bindings

Installation

npm install onfleet

API Overview

Every resource is accessed via your onfleet instance:

var onfleet = require('onfleet')('YOUR_ONFLEET_API_KEY');

Every resource method accepts an optional callback as the last argument:

onfleet.tasks.create(
  { ... },
  function(error, task) {
    error; // null if no error occurred
    task; // the created task object
  }
);

Additionally, every resource method returns a promise, so you don't have to use the regular callback. E.g.

// Create a new task :
onfleet.tasks.create(
  { ... }
).then(function(task) {
  // New task created
}).catch(function(err) {
  // Deal with an error
});

Available resources & methods

Where you see params it is a plain JavaScript object, e.g. { email: '[email protected]' }

• organizations
  • details()
  • delegateeDetails(organizationId)
  • upsertTask(organizationId)
• administrators
  • create([params])
  • list()
  • update(adminId, [params])
  • delete(adminId)
• workers
  • create([params])
  • list()
  • retrieve(workerId)
  • update(workerId, [params])
  • delete(workerId)
  • upsertTask(workerId)
• teams
  • list()
  • retrieve(teamId)
  • create([params])
  • update(teamId, [params])
  • upsertTask(teamId)
  • delete(teamId)
• destinations
  • create([params])
  • retrieve(destinationId)
• recipients
  • create([params])
  • update(recipientId, [params])
  • findByName(recipientName)
  • findByPhone(recipientPhone)
  • retrieve(recipientId)
• tasks
  • create([params])
  • list()
  • retrieve(taskId)
  • update(taskId, [params])
  • complete(taskId, [params])
  • delete(taskId)
• webhooks
  • create([params])
  • list()
  • delete(webhookId)