lob 6.6.2 → 7.0.1

package/README.md

@@ -10,7 +10,12 @@
 
 [![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url]  [![Build Status](https://travis-ci.org/lob/lob-node.svg?branch=master)](https://travis-ci.org/lob/lob-node) [![Dependency Status](https://david-dm.org/lob/lob-node.svg)](https://david-dm.org/lob/lob-node) [![Dev Dependency Status](https://david-dm.org/lob/lob-node/dev-status.svg)](https://david-dm.org/lob/lob-node) [![Coverage Status](https://coveralls.io/repos/lob/lob-node/badge.svg?branch=master)](https://coveralls.io/r/lob/lob-node?branch=master)
 
-Node.js wrapper for the [Lob.com](https://lob.com) API. See full Lob.com documentation [here](https://lob.com/docs/node). For best results, be sure that you're using [the latest version](https://lob.com/docs/node#version) of the Lob API and the latest version of the Node wrapper.
+Node.js wrapper for the [Lob.com](https://lob.com) API. See full Lob.com documentation [here](https://lob.com/docs/node).
+******
+Starting a new project, we recommend using our <a href="https://github.com/lob/lob-typescript-sdk"><strong>TypeScript SDK</strong></a>!
+
+Move your existing project from lob-node to lob-typescript-sdk? <a href="https://github.com/lob/lob-typescript-sdk/blob/main/Migration.md">Checkout this migration guide.</a>
+******
 
 ## Table of Contents
 
@@ -109,7 +114,7 @@ We've provided various examples for you to try out [here](https://github.com/lob
 
 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
+### Accessing Response Headers
 
 You can access response headers via a hidden `_response` property.
 

package/lib/index.js

@@ -3,7 +3,7 @@
 const ClientVersion = require('../package.json').version;
 const Resources     = require('./resources');
 
-const LOB_HOST = 'https://api.lob.com/v1/';
+const LOB_HOST = process.env.LOB_HOST || 'https://api.lob.com/v1/';
 const LOB_USERAGENT = `Lob/v1 NodeBindings/${ClientVersion}`;
 
 const Lob = function (apiKey, options) {

package/lib/resources/campaigns.js

@@ -0,0 +1,34 @@
+'use strict';
+
+const ResourceBase = require('./resourceBase');
+
+class Campaigns extends ResourceBase {
+
+  constructor (config) {
+    super('campaigns', config);
+  }
+
+  list (options, callback) {
+    if (typeof options === 'function') {
+      callback = options;
+      options = {};
+    }
+
+    return this._transmit('GET', null, options, null, callback);
+  }
+
+  retrieve (id, callback) {
+    return this._transmit('GET', id, null, null, callback);
+  }
+
+  delete (id, callback) {
+    return this._transmit('DELETE', id, null, null, callback);
+  }
+
+  create (params, callback) {
+    return this._transmit('POST', null, null, params, callback);
+  }
+
+}
+
+module.exports = Campaigns;

package/lib/resources/index.js

@@ -5,6 +5,7 @@ module.exports = {
   bankAccounts: require('./bankAccounts'),
   bulkIntlVerifications: require('./bulkIntlVerifications'),
   bulkUSVerifications: require('./bulkUSVerifications'),
+  campaigns: require('./campaigns'),
   cards: require('./cards'),
   cardOrders: require('./cardOrders'),
   checks: require('./checks'),

package/package.json

@@ -10,7 +10,7 @@
     "Lob.com",
     "printing"
   ],
-  "version": "6.6.2",
+  "version": "7.0.1",
   "homepage": "https://github.com/lob/lob-node",
   "author": "Lob <support@lob.com> (https://lob.com/)",
   "dependencies": {
@@ -23,10 +23,10 @@
     "cross-env": "^5.2.0",
     "csv-parse": "^4.4.6",
     "eslint": "^8.6.0",
-    "eslint-config-lob": "^1.0.1",
+    "eslint-config-lob": "^5.2.0",
     "generate-changelog": "^1.0.0",
     "json-2-csv": "^3.15.1",
-    "mocha": "^9.1.3",
+    "mocha": "^10.0.0",
     "moment": "^2.22.1",
     "nyc": "^15.1.0",
     "p-map": "^2.1.0",
@@ -39,7 +39,8 @@
   "bugs:": "https://github.com/lob/lob-node/issues",
   "main": "./lib/index",
   "engines": {
-    "node": ">= 10.0.0"
+    "node": ">= 20.0.0",
+    "npm": ">= 11.5.1"
   },
   "scripts": {
     "test": "cross-env NODE_ENV=test nyc mocha test --recursive --timeout 30000",

package/CHANGELOG.md

@@ -1,297 +0,0 @@
-### 6.6.1 (2022-04-11)
-##### Maintenance
-* bump minimist from 1.2.0 to 1.2.6
-* bump moment from 2.29.1 to 2.29.2
-
-### 6.6.1 (2022-04-05)
-##### Maintenance
-* **autocomplete** add query param for address casing
-* Update dependency version
-* Updates to CI process
-* Updates to Repo branch naming
-
-### 6.5.5 (2022-01-14)
-##### Maintenance
-* Removed Bluebird dependency and replaced with p-map
-* Updated 4 out of date dev dependencies
-* Updated min required version of NodeJS to 10
-* Removed package-lock.json from gitignore - it is now included in the repo.
-
-### 6.5.3 (2022-01-04)
-
-##### Features
-* **templates** add support for HTML templates endpoint ([PR_258](https://github.com/lob/lob-node/pull/258))
-
-### 6.5.2 (2021-10-18)
-
-##### Bug Fix
-* **cards:** adds card update route to expose cards update endpoint in SDK. ([PR_256](https://github.com/lob/lob-node/pull/256)) ([6870842](https://github.com/lob/lob-node/pull/256/commits/68708423b03c40c277a183285920b1408d234e4b))
-
-### 6.5.1 (2021-10-14)
-
-##### Bug Fix
-* **card orders:** updates the card orders "quantity_ordered" field to "quantity" in the integration test & example to reflect the recent change in Lob API endpoint for creating card orders. ([PR_254](https://github.com/lob/lob-node/pull/254)) ([9d3a261](https://github.com/lob/lob-node/commit/9d3a261ea3e9dace1e5cd79f43c5cdb40568f6c2))
-
-### 6.5.0 (2021-10-13)
-
-##### Features
-* **cards:** add support for cards endpoint ([PR_252](https://github.com/lob/lob-node/pull/252)) ([e744da5](https://github.com/lob/lob-node/pull/252/commits/e744da5a96543ef4df8245a554e2cf325b79bdfd))
-* **card_orders:** add support for card orders endpoint ([PR_252](https://github.com/lob/lob-node/pull/252)) ([35bc050](https://github.com/lob/lob-node/pull/252/commits/35bc05046e2cd06029dec6e8799f82481cd2078a))
-* **examples:** add examples for creating a card and card order ([PR_252](https://github.com/lob/lob-node/pull/252)) ([1c41494](https://github.com/lob/lob-node/pull/252/commits/1c41494d6a46414f2f9bd5bcd26ed589cff39a06))
-
-### 6.4.0 (2021-09-21)
-
-##### New Features
-
-* **us_verifications:**  Reverse Geocoding endpoint ([#250](https://github.com/lob/lob-node/pull/250)) ([ea1e49df](https://github.com/lob/lob-node/commit/ea1e49df8cace3938acd34811100e8df553a8180))
-* **examples:**  added a bunch of examples which WERE in the old docs ([#249](https://github.com/lob/lob-node/pull/249)) ([bba10957](https://github.com/lob/lob-node/commit/bba109573d379c09f4e6445da263b163ee7184f6))
-
-### 6.3.0 (2021-08-27)
-
-#### 6.2.1 (2021-07-28)
-
-##### Chores
-
-* **deps:**
-  * bump hosted-git-info from 2.1.4 to 2.8.9 ([#241](https://github.com/lob/lob-node/pull/241)) ([a10ed786](https://github.com/lob/lob-node/commit/a10ed786b04ecf4f4380656b2f808996fd7537bb))
-  * bump lodash from 4.17.19 to 4.17.21 ([#239](https://github.com/lob/lob-node/pull/239)) ([b38f7e5e](https://github.com/lob/lob-node/commit/b38f7e5e818385d1435724d23de19513110a11e1))
-  * bump handlebars from 4.5.3 to 4.7.7 ([#238](https://github.com/lob/lob-node/pull/238)) ([72198ab6](https://github.com/lob/lob-node/commit/72198ab65555c8b28c7199570b171aa497e043d7))
-  * bump acorn from 6.2.0 to 6.4.2 ([#233](https://github.com/lob/lob-node/pull/233)) ([533d8309](https://github.com/lob/lob-node/commit/533d83096b50402a579ea8ef5da82915518454cc))
-  * bump yargs-parser from 13.1.1 to 13.1.2 ([#230](https://github.com/lob/lob-node/pull/230)) ([96cd091c](https://github.com/lob/lob-node/commit/96cd091ce6bf5c93dd1dde6855c1734ce2067112))
-  * bump lodash from 4.17.14 to 4.17.19 ([#228](https://github.com/lob/lob-node/pull/228)) ([48e444d1](https://github.com/lob/lob-node/commit/48e444d11a49815f685e11675e307821e4ee12f1))
-* **node14:** add node14 for travis ([#240](https://github.com/lob/lob-node/pull/240)) ([15d83747](https://github.com/lob/lob-node/commit/15d8374798a9f9c79dd6a5db9d566ac285b84b95))
-
-#### 6.2.0 (2021-05-03)
-
-##### New Features
-
-* **self-mailers:** Add support for Self Mailers ([#236](https://github.com/lob/lob-node/pull/236))
-
-##### Chores
-
-* **deps:**  bump y18n from 4.0.0 to 4.0.1 ([#235](https://github.com/lob/lob-node/pull/235)) ([81cbe7b0](https://github.com/lob/lob-node/commit/81cbe7b09f9b86a02502f6c2de0c8b6471826410))
-
-##### Bug Fixes
-
-* **README:**  correct Bank Accounts documentation link ([#234](https://github.com/lob/lob-node/pull/234)) ([f7f7609d](https://github.com/lob/lob-node/commit/f7f7609d439f1a6187af2b4f7f7a8765f3d47ea5))
-
-#### 6.1.1 (2020-11-06)
-
-##### Bug Fixes
-
-* **merge-variables:** convert merge variables to JSON ([#232](https://github.com/lob/lob-node/pull/232)) ([5352dea7](https://github.com/lob/lob-node/commit/5352dea7bbb9ddba12da82967a317edcfda0bfca))
-
-### 6.1.0 (2020-04-15)
-
-##### Chores
-
-* **deps:**
-  * csv-parse@4.4.6, travis node v12, docs (#222) ([7ca4eb05](https://github.com/lob/lob-node/commit/7ca4eb05c8fb149bfdbf3c4fd3e9ed119e73e7d1))
-  * bump eslint-utils from 1.4.0 to 1.4.2 (#217) ([212789c8](https://github.com/lob/lob-node/commit/212789c894189544e8710c0ec1619d6fcd76b3d4))
-
-##### New Features
-
-* **resource:** add ability to specify custom HTTP agent (#224) ([bf925b1c](https://github.com/lob/lob-node/commit/bf925b1c3e54babdd9151de0d1b46ed97b4d61cb))
-
-##### Bug Fixes
-
-* **intl-verifications:** fixed failing test (#219) ([f2b712ad](https://github.com/lob/lob-node/commit/f2b712ad93af4237a4dbb1ba565bc034a9856710))
-
-##### Tests
-
-* **plc:** add tests for new versions (template syntax and cursor pagination) (#226) ([d5806217](https://github.com/lob/lob-node/commit/d580621732acec840bb28532ecb8eb9132e64b3b))
-
-#### 6.0.6 (2019-07-19)
-
-##### Chores
-
-* **deps:**
-  * upgrade vulnerable packages ([#216](https://github.com/lob/lob-node/pull/216)) ([a938fc23](https://github.com/lob/lob-node/commit/a938fc23caf38b87ea6791219d4883e862cdd1c9))
-  * bump lodash from 4.17.11 to 4.17.14 ([#215](https://github.com/lob/lob-node/pull/215)) ([6d6b0436](https://github.com/lob/lob-node/commit/6d6b0436c8caa15d65bfe0534752842c08ee555d))
-
-#### 6.0.5 (2019-02-14)
-
-##### Chores
-
-* **lib:** fixed npm scripts on windows, moved from istanbul to nyc ([#213](https://github.com/lob/lob-node/pull/213)) ([be91922d](https://github.com/lob/lob-node/commit/be91922d59e4fa9cc747c0e8ae2523b6f5d319c6))
-
-#### 6.0.4 (2019-01-30)
-
-##### New Features
-
-* **postcards:** add ability to modify concurrency ([4a3bbf37](https://github.com/lob/lob-node/commit/4a3bbf373727c7c2bd9098b8425988a4adfd70d8))
-
-##### Bug Fixes
-
-* **resource-base:** handle undefined multipart form value ([#212](https://github.com/lob/lob-node/pull/212)) ([711261dc](https://github.com/lob/lob-node/commit/711261dc23d9f09e8ae7050248068219775fb6eb))
-
-#### 6.0.3 (2019-1-7)
-
-##### Chores
-
-* **assets:** update links ([5d7f66f0](https://github.com/lob/lob-node/commit/5d7f66f0487151a3b50b8d4581fe5b2cfa9474a9))
-
-##### Tests
-
-* **api-key:**
-  * remove lob api key from tests and examples ([93fee77a](https://github.com/lob/lob-node/commit/93fee77a156c53eb9454fc0be3a4d220e1943d08))
-  * remove lob api key from tests and examples ([062022b3](https://github.com/lob/lob-node/commit/062022b3cc89b921db4a1dec863d687d0db9dabb))
-
-#### 6.0.2 (2018-12-3)
-
-##### Bug Fixes
-
-* **resource-base:** default body to empty object ([70f9c804](https://github.com/lob/lob-node/commit/70f9c804e1dabd2360afcf307e2e98b4787d46d9))
-* **deps:**
-  * upgrade rest of vulnerable deps ([3b84d7e0](https://github.com/lob/lob-node/commit/3b84d7e09b29b7cbd4718396f8fba7d74bc5b7ec))
-  * upgrade mocha (and growl) version ([95bdf700](https://github.com/lob/lob-node/commit/95bdf700d99986d03cb85ad09d300df1557e8abf))
-* **addresses:** fix broken test (#202) ([e560d6bc](https://github.com/lob/lob-node/commit/e560d6bc207f8d5964470ce1b9b9883829f198e3))
-
-#### 6.0.1 (2018-8-7)
-
-##### Bug Fixes
-
-* **headers:** don't save request specific headers in configs (#201) ([cfa0fb19](https://github.com/lob/lob-node/commit/cfa0fb191581aef2aa4a42c8ca554446700956d8))
-
-## 6.0.0 (2018-07-02)
-
-##### New Features
-
-* **area-mail:** remove areas and routes resources ([a17d234d](https://github.com/lob/lob-node/commit/a17d234da61f38c9a254642109a85aa6a5622810))
-
-### 5.3.0 (2018-05-21)
-
-##### New Features
-
-* **us-autocompletions:**  add USAutocompletions ([b64b02db](https://github.com/lob/lob-node/commit/b64b02db3712d92a6934c37629c804debdfcb42c))
-
-##### Bug Fixes
-
-* **readme:**  replace dependency status badge and upgrade vulnerable deps ([#198](https://github.com/lob/lob-node/pull/198)) ([b758c76d](https://github.com/lob/lob-node/commit/b758c76d3cdd24d379c13ad5189dce4e28efe45e))
-
-### 5.2.0 (2018-3-13)
-
-##### New Features
-
-* **us-verifications:** allow passing queries in verification creation (#197) ([84b9a44a](https://github.com/lob/lob-node/commit/84b9a44a0044eccc33bc8e1a839c54f9ae5cb067))
-
-### 5.1.0 (2018-02-22)
-
-##### Refactors
-
-* **resources:** remove dynamic requires ([#196](https://github.com/lob/lob-node/pull/196)) ([4036cdda](https://github.com/lob/lob-node/commit/4036cdda417fc859dbe737eef48c78d97e38c1a8))
-
-## 5.0.0 (2017-12-11)
-
-##### Chores
-
-* **lib:**
-  * use es6 classes ([38ee703e](https://github.com/lob/lob-node/commit/38ee703e2e03703d4029a922144db53d51320c01))
-  * es6 ify resource and test files ([fbd106f3](https://github.com/lob/lob-node/commit/fbd106f3554dafefc6c0e99d24959eaf7970b6fb))
-* **deprecate:** Deprecate support for 0.10 and 0.12 ([#187](https://github.com/lob/lob-node/pull/187)) ([bd0130d3](https://github.com/lob/lob-node/commit/bd0130d31ff7df699d423043098385cdbec362a7))
-
-##### Bug Fixes
-
-* **test:** fix US verification test ([a0f10925](https://github.com/lob/lob-node/commit/a0f10925bd4e244d69c53c1e9097f3c04f70f5e5))
-* **auto-verify:** update tests to manage auto-verify ([107eeae3](https://github.com/lob/lob-node/commit/107eeae3702290174438fd38ef0ab6d9193b3725))
-
-##### Other Changes
-
-* **postcards:** Remove message field from postcard ([c298fe4c](https://github.com/lob/lob-node/commit/c298fe4c5eace7d746b0215b3f7e5958ae0d18c8))
-
-##### Refactors
-
-* **object:** Use Object.prototype.call, instead of assuming objects inherit from Object.prototype ([#191](https://github.com/lob/lob-node/pull/191)) ([8648cb0c](https://github.com/lob/lob-node/commit/8648cb0cc192650352a061a8c110d09d7345ccf3))
-
-##### Tests
-
-* **intl:** Update international verifications tests ([5f38b3d3](https://github.com/lob/lob-node/commit/5f38b3d3df4b0d44bedd5bbbf5969a5279590b57))
-
-#### 4.1.1 (2017-08-09)
-
-##### Chores
-
-* **examples:**
-  * update to use merge_variables ([cc6c2d3c](https://github.com/lob/lob-node/commit/cc6c2d3c96492f52e0c6a173380985fa691ee86b))
-  * Fix examples to use new us_verifications endpoint ([b6096944](https://github.com/lob/lob-node/commit/b6096944843d1a9ee67632ee6a27688bb3da381a))
-
-##### New Features
-
-* **idempotency-key:** Add optional headers argument to create() methods to support idempotency-key ([99ef7e92](https://github.com/lob/lob-node/commit/99ef7e92cc8e57608553abdd3b8acd38abe08cf3))
-* **us-zip-lookups:** Add US Zip Code Lookup ([d51e8c8b](https://github.com/lob/lob-node/commit/d51e8c8b8f6a9facb1df94d80b230a2387a9e05f))
-* **delete:** Add delete method to postcards, letters, and checks chore(ignore): ignore Sublime files ([aa340b57](https://github.com/lob/lob-node/commit/aa340b579cc87999dc7c0ed1cc571e30cefafbda))
-
-##### Bug Fixes
-
-* **readme:** update documentation ([73afa906](https://github.com/lob/lob-node/commit/73afa906bd393097a3a4d18988e80f8bf6c4308b))
-
-#### 4.1.1 (2017-08-09)
-
-##### Chores
-
-* **examples:**
-  * update to use merge_variables ([cc6c2d3c](https://github.com/lob/lob-node/commit/cc6c2d3c96492f52e0c6a173380985fa691ee86b))
-  * Fix examples to use new us_verifications endpoint ([b6096944](https://github.com/lob/lob-node/commit/b6096944843d1a9ee67632ee6a27688bb3da381a))
-
-##### New Features
-
-* **idempotency-key:** Add optional headers argument to create() methods to support idempotency-key ([99ef7e92](https://github.com/lob/lob-node/commit/99ef7e92cc8e57608553abdd3b8acd38abe08cf3))
-* **us-zip-lookups:** Add US Zip Code Lookup ([d51e8c8b](https://github.com/lob/lob-node/commit/d51e8c8b8f6a9facb1df94d80b230a2387a9e05f))
-* **delete:** Add delete method to postcards, letters, and checks chore(ignore): ignore Sublime files ([aa340b57](https://github.com/lob/lob-node/commit/aa340b579cc87999dc7c0ed1cc571e30cefafbda))
-
-##### Bug Fixes
-
-* **readme:** update documentation ([73afa906](https://github.com/lob/lob-node/commit/73afa906bd393097a3a4d18988e80f8bf6c4308b))
-
-## 4.0.0 (2017-5-17)
-
-##### Chores
-
-* **mock:** use mock.lob.com ([1fed1c75](https://github.com/lob/lob-node/commit/1fed1c753eeb4f6a0ec15ee4f3619c2758d7c08e))
-* **jobs:** removes jobs, objects, settings endpoints ([bbfd446e](https://github.com/lob/lob-node/commit/bbfd446e85f43f870d1c40ed76f6ec7d9ffc8281))
-
-##### Documentation Changes
-
-* **contributing:** changed out-of-date link to valid ([96e21cff](https://github.com/lob/lob-node/commit/96e21cffa16efbe5c5cb3473368ca0362dfbb057))
-
-##### New Features
-
-* **verifications:** add us and intl verification endpoints ENG-2769 ([13f5ed8c](https://github.com/lob/lob-node/commit/13f5ed8c3b1297707f077116d5770dea35c283fa))
-* **version:** support Node versions 0.12, 4, 5, and 6. ([7754b22f](https://github.com/lob/lob-node/commit/7754b22f020343b5adb93e4b9c2a5e8241023cfc))
-
-##### Bug Fixes
-
-* **test:** fixes broken address test ([f22dcf8d](https://github.com/lob/lob-node/commit/f22dcf8d6041c58e5dc766dbf0196d8d62a22130))
-* **examples:** fix typo ([50bb5487](https://github.com/lob/lob-node/commit/50bb5487ea392d16dd5782b3f51fd398a911684a))
-
-### 3.9.0 (2016-4-15)
-
-##### New Features
-
-* **response:** allow access to response headers ([3c4d6514](https://github.com/lob/lob-node/commit/3c4d65149a133b196385849a1296d55b360cc202))
-* **api-version:** support 2016-03-21 ([a304c9cf](https://github.com/lob/lob-node/commit/a304c9cfe927138b8b37345c7ffd2c1fb9f0518f))
-
-### 3.8.0 (2016-2-2)
-
-##### Chores
-
-* **release:** add release scripts ([7cc243eb](https://github.com/lob/lob-node/commit/7cc243eb))
-
-##### New Features
-
-* **version:** support api version 2016-01-19 ([6cb6cec0](https://github.com/lob/lob-node/commit/6cb6cec0))
-* **bank-accounts:** standardize verify function ([1d0b37c2](https://github.com/lob/lob-node/commit/1d0b37c2))
-* **deps:** remove gulp ([a2c164a7](https://github.com/lob/lob-node/commit/a2c164a7))
-
-##### Bug Fixes
-
-* **errors:** always throw Error object ([41c88f97](https://github.com/lob/lob-node/commit/41c88f97))
-* **readme:** update testing instructions ([f193cb0a](https://github.com/lob/lob-node/commit/f193cb0a))
-
-##### Tests
-
-* **resources:** standardize and remove unnecessary tests ([ad0e45ed](https://github.com/lob/lob-node/commit/ad0e45ed))
-* **setup:** use global expect, api key, Lob ([6e44ce0b](https://github.com/lob/lob-node/commit/6e44ce0b))
-
-## [**2.6.2**](https://github.com/lob/lob-node/releases/tag/v2.6.2)
-- [**#88**] (https://github.com/lob/lob-node/pull/88) changed asset URLs to use lob-assets bucket