jbettcher/lob-node

Node.js Wrapper for Lob API

lob-node

Node.js wrapper for the Lob.com API. See full Lob.com documentation here. For best results, be sure that you're using the latest version of the Lob API and the latest version of the Node wrapper.

Table of Contents

• Getting Started
  • Registration
  • Installation
  • Usage
  • Options
• Examples
• API Documentation
• Contributing
• Testing

Getting Started

Here's a general overview of the Lob services available, click through to read more.

• Postcards API
• Letters API
• Checks API
• Area Mail API
• Address Verification API

Please read through the official API Documentation to get a complete sense of what to expect from each endpoint.

Registration

First, you will need to first create an account at Lob.com and obtain your Test and Live API Keys.

Once you have created an account, you can access your API Keys from the Settings Panel.

Installation

lob-node can be installed through the npm:

$ npm install lob

To build and install from the latest source:

$ git clone git@github.com:lob/lob-node.git
$ npm install

Usage

var Lob = require('lob')('YOUR API KEY');

// change api version
var Lob = require('lob')('YOUR API KEY', { apiVersion: 'API-VERSION' });

// change internal defaults (e.g. host)
var options = {/* see options below */};
var Lob = require('lob')('YOUR API KEY', options);

// you can also just pass options
var options = { apiKey: 'foo', host: 'bar' };
var Lob = require('lob')(options);

// callback pattern
Lob.addresses.list(function (err, body) {
  if (err) return callback(err);
  return callback(null, body.data);
});

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

var Lob = require('lob')('YOUR API KEY');

Lob.addresses.list()
.then(function (res) {
  console.log(res.data);
})
.catch(function (e) {
  console.log(e);
});

Options

The Lob constructor accepts an options object which may contain one or more of the following options:

• apiVersion - Optionally set the version of the Lob API to use. Defaults to latest.
• host - Override the default host API calls are issued to.
• userAgent - Override the default userAgent.
• headers - Edit the headers sent in all API calls.

Examples

We've provided various examples for you to try out here.

There are simple scripts to demonstrate how to create all the core Lob objects (checks, letters, postcards. etc.) as well as more complex examples that utilize other libraries and external files.

Accessing Response Headers

You can access response headers via a hidden _response property.

Lob.addresses.list()
.then(function (res) {
  res._response.headers['content-type'];
  // => "application/json; charset=utf-8"
});

You can also access headers from errors.

Lob.addresses.retrieve('adr_bad_id')
.catch(function (err) {
  err._response.headers['content-type'];
  // => "application/json; charset=utf-8"
});

API Documentation

• Introduction
• Versioning
• Errors
• Rate Limiting
• Webhooks
• Cancellation Windows
• Scheduled Mailings
• Metadata
• HTML Templates
• Asset URLs
• Addresses
  • Address Book
    • The Address Object
    • Create an Address
    • Retrieve an Address
    • Delete an Address
    • List all Addresses
• US Verification API
  • US Verification API
    • The US Verification Object
    • Verify a US Address
    • The US ZIP Lookup Object
    • Lookup a US ZIP Code
• Int'l Verification API
  • International Verifications
    • Verify an International Address
• Postcards API
  • Postcards
    • The Postcard Object
    • Create a Postcard
    • Retrieve a Postcard
    • Cancel a Postcard
    • List all Postcards
• Letters API
  • Letters
    • The Letter Object
    • Create a Letter
    • Retrieve a Letter
    • Cancel a Letter
    • List all Letters
• Checks API
  • Checks
    • The Check Object
    • Create a Check
    • Retrieve a Check
    • Cancel a Check
    • List all Checks
  • Bank Accounts
    • The Bank Account Object
    • Create a Bank Account
    • Retrieve a Bank Account
    • Delete a Bank Account
    • Verify a Bank Account
    • List all Bank Accounts
• Area Mail API
  • Areas
    • The Area Object
    • Create an Area Mailing
    • Retrieve an Area Mailing
    • List all Area Mailings
  • Routes
    • The Routes Object
    • Retrieve Routes
    • List all Routes
• Appendix
  • API Changelog
  • The Tracking Event Object
  • Events
  • HTML Examples
  • Image Prepping
  • US Verification Details

Contributing

To contribute, please see the CONTRIBUTING.md file.

Testing

To run the tests with coverage:

npm test

To run the tests without coverage:

npm run test-no-cover

=======================

Copyright © 2013 Lob.com

Released under the MIT License, which can be found in the repository in LICENSE.txt.