Giter Site home page Giter Site logo

lob-node's Introduction

lob-node

NPM version Downloads Build Status Dependency Status Coverage Status

Node.js wrapper for the Lob.com API.

Table of Contents

Installation

Getting Started

Supported Image Types

Creating a PDF

Usage

API

Installation

lob-node can be installed through the npm:

$ npm install lob

To build and install from the latest source:

$ git clone [email protected]:lob/lob-node.git
$ npm install

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

Supported Image Types

  • PDF
  • PNG
  • JPEG

For more information on prepping the images please see the Lob documentation

Creating a PDF

If you need to generate your own PDF programmatically we recommend using pdfkit. There is an example provided in the examples folder here.

##Usage

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

// alternative way to initialize
var lobFactory = require('lob');
var Lob = new lobFactory('YOUR API KEY');

// change api version
var Lob = require('lob')('YOUR API KEY');
Lob.setVersion('api_version');

For a detailed API reference see below

##API

###Lob.jobs #####Lob.jobs.retrieve(String id, Function done)

// Retrieve a particular job JOB_ID = "job_*" (required)
Lob.jobs.retrieve('job_f6f4c0c3f6338136', function (err, res) {
  console.log(err, res);
});

#####Lob.jobs.list(Object options, Function done)

// List 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({count: 5, offset: 10}, function (err, res) {
  console.log(err, res);
});

#####Lob.jobs.create(Object params, Function done)

//using ID's you already created
Lob.jobs.create({
  name: 'Lob Test Job',
  from: 'adr_71d64099e6729996', //Can pass an ID
  to: { // or an inline address object
    name: 'Jane Smith',
    email: '[email protected]',
    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: [
    'obj_fe40799250bac8f6', // use an ID
    { // or an inline object
      name: 'GO BLUE',
      file: 'https://s3-us-west-2.amazonaws.com/lob-assets/goblue.pdf',
      setting_id: 100
    }

  ] // always an array
}, function (err, res) {
  console.log(err, res);
});

###Lob.addresses #####Lob.addresses.retrieve(String id, Function done)

// Retrieve a particular address address object
//
Lob.addresses.retrieve('adr_cda562558b71ff93', function (err, res) {
  console.log(err, res);
});

#####Lob.addresses.delete(String id, Function done)

// Delete an Address Object (make sure it exists first)
//
Lob.addresses.delete('adr_71d64099e6729996', function (err, res) {
  console.log(err, res);
});

#####Lob.addresses.list(Object options, Function done)

// 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({count: 10, offset: 5}, function (err, res) {
  console.log(err, res);
});

#####Lob.addresses.create(Object params, Function done)

Lob.addresses.create({
  name: 'Test Name',
  email: '[email protected]',
  phone: '123456789',
  address_line1: '123 Test Street',
  address_line2: 'Unit 199',
  address_city: 'Chicago',
  address_state: 'IL',
  address_zip: '60012',
  address_country: 'US',
}, function (err, res) {
  console.log(err, res);
});

###Lob.objects #####Lob.objects.retrieve(String id, Function done)

// Retrieve a particular object OBJECT_ID = "obj_*" (required)
//
Lob.objects.retrieve('obj_1d1188df1e8d6427', function (err, res) {
  console.log(err, res);
});

#####Lob.objects.list(Object options, Function done)

// List All Objects with default offset:0, count:0
//
Lob.objects.list(function (err, res) {
  console.log(err, res);
});

// List Objects with count:10, offset:5
//
Lob.objects.list({count: 10, offset: 5}, function (err, res) {
  console.log(err, res);
});

#####Lob.objects.create(Object params, Function done)

// Creating an Object with local file
//
Lob.objects.create({
  name: 'My First Object',
  file: '@/home/Downloads/goblue.pdf',
  setting_id: 100
}, function (err, res) {
  console.log(err, res);
});

// Creating an Object with remote file
//
Lob.objects.create({
  name: 'My First Object',
  file: 'https://s3-us-west-2.amazonaws.com/lob-assets/goblue.pdf',
  setting_id: 100
}, function (err, res) {
  console.log(err, res);
});

#####Lob.objects.delete(String id, Function done)

Lob.objects.delete('obj_1d1188df1e8d6427', function (err, res) {
  console.log(err, res);
});

###Lob.settings #####Lob.settings.retrieve(String id, Function done)

#####Lob.settings.create(Object params, Function done)

###Lob.services #####Lob.services.retrieve(String id, Function done)

// Retrieve a particular service object
//
Lob.services.retrieve('2', function (err, res) {
  console.log(err, res);
});

#####Lob.services.list(Object options, Function done)

// List All services
//
Lob.services.list(function (err, res) {
  console.log(err, res);
});

###Lob.postcards #####Lob.postcards.retrieve(String id, Function done)

// Retrieve a particular postcard object
//
Lob.postcards.retrieve('psc_056fdd2b4a11a169', function (err, res) {
  console.log(err, res);
});

#####Lob.postcards.list(Object options, Function done)

// List All Postcards with default offset:0, count:0
//
Lob.postcards.list(function (err, res) {
  console.log(err, res);
});

// List All Postcards with offset:10, count:5
//
Lob.postcards.list({offset: 10, count: 5}, function (err, res) {
  console.log(err, res);
});

#####Lob.postcards.create(Object params, Function done)

// Creating PostCard with local file
//
Lob.postcards.create({
  name: 'Test Card',
  to: 'adr_3b5fe0b76713a6e8',
  front: '@/home/Downloads/postcardfront.pdf',
  back: '@/home/Downloads/postcardback.pdf'
}, function (err, res) {
  console.log(err, res);
});
/**/

// Creating a PostCard with remote file
//
Lob.postcards.create({
  name: 'My First Postcard',
  to: 'adr_3b5fe0b76713a6e8',
  front: 'https://s3-us-west-2.amazonaws.com/lob-assets/postcardfront.pdf',
  back: 'https://s3-us-west-2.amazonaws.com/lob-assets/postcardback.pdf'
}, function (err, res) {
  console.log(err, res);
});
/**/

// Creating a PostCard with local, remote file
//
Lob.postcards.create({
  name: 'My First Postcard',
  to: 'adr_3b5fe0b76713a6e8',
  front: 'https://s3-us-west-2.amazonaws.com/lob-assets/postcardback.pdf',
  back: 'https://s3-us-west-2.amazonaws.com/lob-assets/postcardback.pdf'
}, function (err, res) {
  console.log(err, res);
});

###Lob.checks #####Lob.checks.retrieve(String id, Function done)

// Retrieve a particular check object
//
Lob.checks.retrieve('psc_056fdd2b4a11a169', function (err, res) {
  console.log(err, res);
});

#####Lob.checks.list(Object options, Function done)

// List All Checks with default offset:0, count:0
//
Lob.checks.list(function (err, res) {
  console.log(err, res);
});
/**/

#####Lob.checks.create(Object params, Function done)

// Creating Check
/**/
Lob.checks.create({
  name: 'Test Check',
  check_number: '10000',
  bank_account: 'bank_7a88fa3abe5e2da',
  to: 'adr_3b5fe0b76713a6e8',
  amount: 100,
  memo: 'THis is my first Check',
  message: 'this check is for laundry'
}, function (err, res) {
  console.log(err, res);
});
/**/
// Creating Check with Bank Account
/**/
Lob.bankAccounts.create({
  routing_number: '123456789',
  account_number: '123456788',
  bank_address: {
    name: 'Chase',
    address_line1: '123 Test Street',
    address_line2: 'Unit 199',
    address_city: 'Bangalore',
    address_state: 'KA',
    address_zip: '560039',
    address_country: 'IN',
  },
  account_address: {
    name: 'Lob.com',
    address_line1: '123 Test Street',
    address_line2: 'Unit 199',
    address_city: 'Bangalore',
    address_state: 'KA',
    address_zip: '560039',
    address_country: 'IN',
  }
}, function (err, res) {
  Lob.checks.create({
    name: 'TEST_CHECK',
    bank_account: res.id,
    to: 'adr_8613108bcfa00806',
    amount: 100,
    memo: 'test check'
  }, function (err, res2) {
    console.log(err, res2);
  });
});
/**/

###Lob.bankAccounts #####Lob.bankAccounts.retrieve(String id, Function done)

// Retrieve a particular Bank Account Object
//
Lob.bankAccounts.retrieve('bank_7a88fa3abe5e2da', function (err, res) {
  console.log(err, res);
});

#####Lob.bankAccounts.delete(String id, Function done)

// Deleting a bank account
Lob.bankAccounts.delete('bank_7a88fa3abe5e2da', function (err, res) {
  console.log(err, res);
});

#####Lob.bankAccounts.list(Object options, Function done)

// List All Accounts with default offset:0, count:10
//
Lob.bankAccounts.list(function (err, res) {
  console.log(err, res);
});

#####Lob.bankAccounts.create(Object params, Function done)

// 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);
});

###Lob.areas #####Lob.areas.retrieve(String id, Function done)

// Retrieve a particular Area
Lob.areas.retrieve('area_350e47ace201ee4', function (err, res) {
  console.log(err, res);
});

#####Lob.areas.list(Object options, Function done)

// List all areas with count: 5 and offset: 10
Lob.areas.list({count: 5, offset: 10}, function (err, res) {
  console.log(err, res);
});

#####Lob.areas.create(Object params, Function done)

// Create an area mailing with a mix of local and remote files
// You can mix and match (for example, both local or both remote)
Lob.areas.create({
  front: '@/path/to/local/file',
  back: 'https://s3-us-west-2.amazonaws.com/lob-assets/areaback.pdf',
  routes: ['94107-C031', '94158-C031'], // required
  target_type: 'all', // optional
  full_bleed: 1 // optional
}, function (err, res) {
  console.log(err, res);
})

###Lob.routes #####Lob.routes.list(Object options, Function done)

// List all routes for a set of zip codes
Lob.routes.list({
  zip_codes: ['94108', '94709', '94608']
}, function (err, res) {
  console.log(err, res);
});

###Lob.verification #####Lob.verification.verify(Object params, Function done)

Lob.verification.verify({ // Inline address only
  address_line1: '325 Berry Street',
  address_line2: 'Unit 211',
  address_city: 'San Francisco',
  address_state: 'CA',
  address_zip: '94158',
  address_country: 'US',
}, function (err, res) {
  console.log (err, res);
});

###Lob.countries #####Lob.countries.list(Object options, Function done)

// List All Countries with defaults
//
Lob.countries.list(function (err, res) {
  console.log(err, res);
});

###Lob.states #####Lob.states.list(Object options, Function done)

Lob.states.list(function (err, res) {
  console.log(err, res);
});

Running the test-suite

To run the tests with coverage:

gulp testCI

To run the tests without coverage:

gulp test

Credits

Copyright © 2013 Lob.com

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

lob-node's People

Contributors

amrit avatar bendrucker avatar bsiddiqui avatar graysonchao avatar harry-zhang avatar jromer94 avatar leore avatar pon avatar sankar4n avatar shrav avatar

Watchers

avatar 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.