lob-node

Node.js wrapper for the Lob.com API.

Installation

semantics3-node can be installed through the npm:

$ npm install lob

To build and install from the latest source:

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

Getting Started

In order to use the client, you must have an API key. To obtain your key, you need to first create an account at Lob.com

You can access your API access credentials from the Accounts Page

Usage

Initialization and configuration

var LOB = new (require('lob')) (LOB_API_KEY);

var LOB = require('lob');
LOB = new LOB(LOB_API_KEY);

or you can even pass as a config object

LOB = new LOB({key: LOB_API_KEY});
LOB = new LOB({endpoint: 'https://api.lob.com/v1/', key: LOB_API_KEY});

Single Print Service

Jobs

List All Jobs with default offset:0, count:0

LOB.jobs.list(function(err, data) {
  console.log(err, data);
});

List Jobs with offset:10, count:5

LOB.jobs.list(10, 5, function(err, res) {
  console.log(err, res);
});

Retrieve a particular job JOB_ID = "job_*" (required)

LOB.jobs.get("job_f6f4c0c3f6338136", function(err, res) {
  console.log(err, res);
});

Creating a job with objects

LOB.jobs.create({
  name: "Testing",
  from: "adr_71d64099e6729996",
  to:{
    name: "Harry Zhang",
      email: "harry@lob.com",
      phone: "5555555555",
      address_line1: "123 Test Street",
      address_line2: "Unit 199",
      address_city: "Mountain View",
      address_state: "CA",
      address_zip: "94085",
      address_country: "US",
  },
  objects: [
    {
      name: "GO BLUE",
      file: "https://www.lob.com/goblue.pdf",
      setting_id: 100
    },
    "obj_fe40799250bac8f6"
  ]
}, function(err, res) {
  console.log(err, res);
});

Addresses

List All Addresses with default offset:0, count:0

LOB.addresses.list(function(err, res) {
  console.log(err, res);
});

List Addreses with offset:10, count:5

LOB.addresses.list(10, 5, function(err, res) {
  console.log(err, res);
});

Retrieve a particular address ADDRESS_ID = "adr_*" (required)

LOB.addresses.get("adr_cda562558b71ff93", function(err, res) {
  console.log(err, res);
});

Creating an Address Object

LOB.addresses.create({
  name: "Sankaran K",
    email: "mail@sankarank.in",
    phone: "+919731115163",
    address_line1: "123 Test Street",
    address_line2: "Unit 199",
    address_city: "Bangalore",
    address_state: "KA",
    address_zip: "560039",
    address_country: "IN",
}, function(err, res) {
  console.log(err, res);
});

Update an Address Object

LOB.addresses.update("adr_3b5fe0b76713a6e8", {
  name: "Sankaran Kaliappan",
    email: "mail@sankarank.in",
    phone: "+91 (973)-111 5163",
    address_state: "KARNATAKA",
    address_zip: "560029"
}, function(err, res) {
  console.log(err, res);
});

Delete an Address Object

LOB.addresses.delete("adr_71d64099e6729996", function(err, res) {
  console.log(err, res);
});

Verify an Address

LOB.addresses.verify({
  address_line1: "220 William T Morrissey Boulevard",
    address_city: "Boston",
    address_state: "MA",
}, function(err, res) {
  console.log(err, res);
});

Objects

List All Objects with default offset:0, count:0

LOB.objects.list(function(err, res) {
  console.log(err, res);
});

List Objects with offset:10, count:5

LOB.objects.list(10, 5, function(err, res) {
  console.log(err, res);
});

Retrieve a particular object OBJECT_ID = "obj_*" (required)

LOB.objects.get("obj_1d1188df1e8d6427", function(err, res) {
  console.log(err, res);
});

Creating an Object with local file

LOB.objects.create({
    name: "TEST_OBJECT",
    file: "@/home/sankaran/Downloads/goblue.pdf",
    setting_id: 100
}, function(err, res) {
  console.log(err, res);
});

Creating an Object with remote file

LOB.objects.create({
    name: "TEST_OBJECT",
    file: "https://www.lob.com/goblue.pdf",
    setting_id: 100
}, function(err, res) {
  console.log(err, res);
});

Delete an Object

LOB.objects.delete("obj_1d1188df1e8d6427", function(err, res) {
  console.log(err, res);
});

Settings

List All settings

LOB.settings.list(function(err, res) {
  console.log(err, res);
});

Retrieve a particular setting by SETTING_ID (required)

LOB.settings.get("100", function(err, res) {
  console.log(err, res);
});

Packagings

List All packagings

LOB.packagings.list(function(err, res) {
  console.log(err, res);
});

Retrieve a particular packaging by PACKAGING_ID (required)

LOB.packagings.get("2", function(err, res) {
  console.log(err, res);
});

Services

List All services

LOB.services.list(function(err, res) {
  console.log(err, res);
});

Retrieve a particular service by SERVICE_ID (required)

LOB.services.get("2", function(err, res) {
  console.log(err, res);
});

Simple Postcard Service

Postcards

List All Postcards with default offset:0, count:0

LOB.postcards.list(function(err, res) {
  console.log(err, res);
});

Retrieve a particular postcard by POSTCARD_ID = "psc_*" (required)

LOB.postcards.get("psc_056fdd2b4a11a169", function(err, res) {
  console.log(err, res);
});

Creating PostCard with local file

LOB.postcards.create({
    name: "TEST_POSTCARD",
    to: "adr_3b5fe0b76713a6e8",
    front: "@/home/sankaran/Downloads/postcardfront.pdf",
    back: "@/home/sankaran/Downloads/postcardback.pdf"
}, function(err, res) {
  console.log(err, res);
});

Creating an PostCard with remote file

LOB.postcards.create({
    name: "TEST_POSTCARD",
    to: "adr_3b5fe0b76713a6e8",
    front: "https://www.lob.com/postcardfront.pdf",
    back: "https://www.lob.com/postcardback.pdf"
}, function(err, res) {
  console.log(err, res);
});

Creating an PostCard with local, remote file

LOB.postcards.create({
    name: "TEST_POSTCARD",
    to: "adr_3b5fe0b76713a6e8",
    front: "@/home/sankaran/Downloads/postcardfront.pdf",
    back: "https://www.lob.com/postcardback.pdf"
}, function(err, res) {
  console.log(err, res);
});

Creating an PostCard with a buffer of a generated pdf

// Using something like PDFKit...
doc = new PDFDocument({size: [432, 288]});
doc.fontSize(30).text('hello!');
doc.output(function(buffer) {
  LOB.postcards.create({
      name: "TEST_POSTCARD",
      to: "adr_3b5fe0b76713a6e8",
      front: "@/home/sankaran/Downloads/postcardfront.pdf",
      back: buffer
  }, function(err, res) {
    console.log(err, res);
  });
});

Simple Check Service

Checks

List All Checks with default offset:0, count:0

LOB.checks.list(function(err, res) {
  console.log(err, res);
});

Retrieve a particular check by CHECK_ID = "chk_*" (required)

LOB.checks.get("psc_056fdd2b4a11a169", function(err, res) {
  console.log(err, res);
});

Creating Check

LOB.checks.create({
    name: "TEST_CHECK",
    check_number: "000000",
    bank_account: "bank_7a88fa3abe5e2da",
    to: "adr_3b5fe0b76713a6e8",
    amount: 100,
    memo: "testing"
}, function(err, res) {
  console.log(err, res);
});

Bank Accounts

List All Accounts with default offset:0, count:0

LOB.bankAccounts.list(function(err, res) {
  console.log(err, res);
});

Retrieve a particular Account by ACCOUNT_ID = "bank_*" (required)

LOB.bankAccounts.get("bank_7a88fa3abe5e2da", function(err, res) {
  console.log(err, res);
});

Creating a Bank Account

LOB.bankAccounts.create({
    routing_number: 123456789,
    account_number: 123456789,
    bank_code: 123456789,
    bank_address: {
      name: "Chase Bank",
      address_line1: "55 Edmonds",
      address_city: "Palo Alto",
      address_state: "CA",
      address_zip: "90081",
      address_country: "US"
    },
    account_address: {
      name: "Leore Avidar",
      address_line1: "123 Test Street",
      address_city: "Sunnyvale",
      address_state: "CA",
      address_zip: "94085",
      address_country: "US"
    }
}, function(err, res) {
  console.log(err, res);
});

Utils

Address Verification