lob 6.4.0 → 6.5.3

package/CHANGELOG.md

@@ -1,3 +1,25 @@
+### 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

package/README.md

@@ -14,12 +14,14 @@ Node.js wrapper for the [Lob.com](https://lob.com) API. See full Lob.com documen
 
 ## Table of Contents
 
+- [Table of Contents](#table-of-contents)
 - [Getting Started](#getting-started)
   - [Registration](#registration)
   - [Installation](#installation)
   - [Usage](#usage)
   - [Options](#options)
 - [Examples](#examples)
+    - [Accessing Response Headers](#accessing-response-headers)
 - [API Documentation](#api-documentation)
 - [Contributing](#contributing)
 - [Testing](#testing)
@@ -131,81 +133,7 @@ Lob.addresses.retrieve('adr_bad_id')
 
 ## API Documentation
 
-- [Introduction](https://lob.com/docs/node#introduction)
-- [Versioning](https://lob.com/docs/node#version)
-- [Errors](https://lob.com/docs/node#errors)
-- [Rate Limiting](https://lob.com/docs/node#rate-limits)
-- [Webhooks](https://lob.com/docs/node#webhooks)
-- [Cancellation Windows](https://lob.com/docs/node#cancellation)
-- [Scheduled Mailings](https://lob.com/docs/node#scheduled)
-- [Metadata](https://lob.com/docs/node#metadata)
-- [HTML Templates](https://lob.com/docs/node#templates)
-- [Asset URLs](https://lob.com/docs/node#urls)
-- **Addresses**
-  - [Address Book](https://lob.com/docs/node#addresses)
-    - [The Address Object](https://lob.com/docs/node#addresses_object)
-    - [Create an Address](https://lob.com/docs/node#addresses_create)
-    - [Retrieve an Address](https://lob.com/docs/node#addresses_retrieve)
-    - [Delete an Address](https://lob.com/docs/node#addresses_delete)
-    - [List all Addresses](https://lob.com/docs/node#addresses_list)
-- **US Verification API**
-  - [US Verification API](https://lob.com/docs/node#us_verifications)
-    - [The US Verification Object](https://lob.com/docs/node#us_verifications_object)
-    - [Verify a US Address](https://lob.com/docs/node#us_verifications_create)
-    - [Bulk Verify US Addresses](https://lob.com/docs/node#us_verifications_bulk_create)
-    - [The US ZIP Lookup Object](https://lob.com/docs/node#us_zip_lookups_object)
-    - [Lookup a US ZIP Code](https://lob.com/docs/node#us_zip_lookups_create)
-    - [Reverse Lookup a Geocode Location](https://lob.com/docs/node#us_zip_lookups_create)
-  - [US Autocompletion API](https://lob.com/docs/node#us_autocompletions)
-    - [The US Autocompletion Object](https://lob.com/docs/node#us_autocompletions_object)
-    - [Autocomplete a US Address](https://lob.com/docs/node#us_autocompletions_create)
-    - [The US Autocompletion Test Environment](https://lob.com/docs/node#us-autocompletions-test-environment)
-- **Int'l Verification API**
-  - [International Verifications](https://lob.com/docs/node#intl_verifications)
-    - [Verify an International Address](https://lob.com/docs/node#intl_verifications_create)
-    - [Bulk Verify International Addresses](https://lob.com/docs/node#intl_verifications_bulk_create)
-- **Postcards API**
-  - [Postcards](https://lob.com/docs/node#postcards)
-    - [The Postcard Object](https://lob.com/docs/node#postcards_object)
-    - [Create a Postcard](https://lob.com/docs/node#postcards_create)
-    - [Retrieve a Postcard](https://lob.com/docs/node#postcards_retrieve)
-    - [Cancel a Postcard](https://lob.com/docs/node#postcards_delete)
-    - [List all Postcards](https://lob.com/docs/node#postcards_list)
-- **Self Mailers API**
-  - [Self Mailers](https://lob.com/docs/node#self_mailers)
-    - [The Self Mailer Object](https://lob.com/docs/node#self_mailers_object)
-    - [Create a Self Mailer](https://lob.com/docs/node#self_mailers_create)
-    - [Retrieve a Self Mailer](https://lob.com/docs/node#self_mailers_retrieve)
-    - [Cancel a Self Mailer](https://lob.com/docs/node#self_mailers_delete)
-    - [List all Self Mailers](https://lob.com/docs/node#self_mailers_list)
-- **Letters API**
-  - [Letters](https://lob.com/docs/node#letters)
-    - [The Letter Object](https://lob.com/docs/node#letters_object)
-    - [Create a Letter](https://lob.com/docs/node#letters_create)
-    - [Retrieve a Letter](https://lob.com/docs/node#letters_retrieve)
-    - [Cancel a Letter](https://lob.com/docs/node#letters_delete)
-    - [List all Letters](https://lob.com/docs/node#letters_list)
-- **Checks API**
-  - [Checks](https://lob.com/docs/node#checks)
-    - [The Check Object](https://lob.com/docs/node#checks_object)
-    - [Create a Check](https://lob.com/docs/node#checks_create)
-    - [Retrieve a Check](https://lob.com/docs/node#checks_retrieve)
-    - [Cancel a Check](https://lob.com/docs/node#checks_delete)
-    - [List all Checks](https://lob.com/docs/node#checks_list)
-  - [Bank Accounts](https://lob.com/docs/node#bankaccounts)
-    - [The Bank Account Object](https://lob.com/docs/node#bankaccounts_object)
-    - [Create a Bank Account](https://lob.com/docs/node#bankaccounts_create)
-    - [Retrieve a Bank Account](https://lob.com/docs/node#bankaccounts_retrieve)
-    - [Delete a Bank Account](https://lob.com/docs/node#bankaccounts_delete)
-    - [Verify a Bank Account](https://lob.com/docs/node#bankaccounts_verify)
-    - [List all Bank Accounts](https://lob.com/docs/node#bankaccounts_list)
-- **Appendix**
-  - [API Changelog](https://lob.com/docs/node#changelog)
-  - [The Tracking Event Object](https://lob.com/docs/node#tracking_event_object)
-  - [Events](https://lob.com/docs/node#events)
-  - [HTML Examples](https://lob.com/docs/node#html-examples)
-  - [Image Prepping](https://lob.com/docs/node#prepping)
-  - [US Verification Details](https://lob.com/docs/node#us_verification_details)
+The full and comprehensive documentation of Lob's APIs is available [here](https://docs.lob.com/).
 
 ## Contributing
 

package/lib/resources/cardOrders.js

@@ -0,0 +1,21 @@
+'use strict';
+
+const ResourceBase = require('./resourceBase');
+
+class CardOrders extends ResourceBase {
+
+  constructor (config) {
+    super('cards', config);
+  }
+
+  list (cardId, params, callback) {
+    return this._transmit('GET', `${encodeURIComponent(cardId)}/orders`, null, params, null, callback);
+  }
+
+  create (cardId, params, headers, callback) {
+    return this._transmit('POST', `${encodeURIComponent(cardId)}/orders`, null, params, headers, callback);
+  }
+
+}
+
+module.exports = CardOrders;

package/lib/resources/cards.js

@@ -0,0 +1,80 @@
+'use strict';
+
+const ResourceBase = require('./resourceBase');
+
+class Cards extends ResourceBase {
+
+  constructor (config) {
+    super('cards', 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);
+  }
+
+  update (id, params, callback) {
+    return this._transmit('POST', id, null, params, callback);
+  }
+
+  delete (id, callback) {
+    return this._transmit('DELETE', id, null, null, callback);
+  }
+
+  create (params, headers, callback) {
+    let isBuffer;
+
+    if (params.front) {
+      isBuffer = Buffer.isBuffer(params.front);
+
+      if (isBuffer) {
+        params.front = {
+          value: params.front,
+          options: { filename: 'front.pdf' }
+        };
+      }
+    }
+
+    if (params.back) {
+      isBuffer = Buffer.isBuffer(params.back);
+
+      if (isBuffer) {
+        params.back = {
+          value: params.back,
+          options: { filename: 'back.pdf' }
+        };
+      }
+    }
+
+    for (const p in params) {
+
+      if (p === 'merge_variables' && params[p] instanceof Object) {
+        params[p] = JSON.stringify(params[p]);
+      }
+
+      if (p === 'front' || p === 'back' || !(params[p] instanceof Object)) {
+        continue;
+      }
+
+      for (const key in params[p]) {
+        params[`${p}[${key}]`] = params[p][key];
+      }
+
+      delete params[p];
+    }
+
+    return this._transmit('POST', null, null, params, headers, callback);
+  }
+
+}
+
+module.exports = Cards;

package/lib/resources/index.js

@@ -5,6 +5,8 @@ module.exports = {
   bankAccounts: require('./bankAccounts'),
   bulkIntlVerifications: require('./bulkIntlVerifications'),
   bulkUSVerifications: require('./bulkUSVerifications'),
+  cards: require('./cards'),
+  cardOrders: require('./cardOrders'),
   checks: require('./checks'),
   intlVerifications: require('./intlVerifications'),
   letters: require('./letters'),
@@ -13,5 +15,6 @@ module.exports = {
   usAutocompletions: require('./usAutocompletions'),
   usReverseGeocodeLookups: require('./usReverseGeocodeLookups'),
   usVerifications: require('./usVerifications'),
-  usZipLookups: require('./usZipLookups')
+  usZipLookups: require('./usZipLookups'),
+  templates: require('./templates')
 };

package/lib/resources/templates.js

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

package/package.json

@@ -10,7 +10,7 @@
     "Lob.com",
     "printing"
   ],
-  "version": "6.4.0",
+  "version": "6.5.3",
   "homepage": "https://github.com/lob/lob-node",
   "author": "Lob <support@lob.com> (https://lob.com/)",
   "dependencies": {
@@ -46,7 +46,7 @@
     "test-no-cover": "cross-env NODE_ENV=test mocha test --recursive --timeout 30000",
     "coverage": "nyc report --reporter=text",
     "enforce": "nyc check-coverage --statements 100 --lines 100 --functions 100 --branches 100",
-    "coveralls": "nyc report --reporter=text-lcov | coveralls",
+    "test-lcov": "nyc report --reporter=lcov",
     "lint": "eslint .",
     "lint:fix": "eslint . --fix",
     "release:patch": "changelog -p && git add CHANGELOG.md && git commit -m 'updated CHANGELOG.md' && npm version patch && git push origin && git push origin --tags",