checkbook-api - npm Package Compare versions

Comparing version 3.1.0 to 3.2.0

lib/endpoints/user.js

@@ -25,2 +25,9 @@ 'use strict';
 
+    get: function(callback) {
+        return this.resource.request({
+            method: 'GET',
+            uri: '/user'
+        }, callback);
+    },
+
     list: function(query, callback) {
@@ -27,0 +34,0 @@ return this.resource.request({

package.json

 {
   "name": "checkbook-api",
-  "version": "3.1.0",
+  "version": "3.2.0",
   "description": "Node.js library for the Checkbook.io API",
@@ -33,5 +33,5 @@ "keywords": [
   "dependencies": {
-    "lodash": "^4.17.10",
+    "lodash": "^4.17.11",
     "request": "^2.88.0"
   }
 }

README.md

@@ -35,3 +35,3 @@ # Node.js library for the Checkbook.io API
 
-If you wish to send requests on behalf of another user, this user will use OAuth in order to generate a key that may be used on their behalf. You can get more details on our [OAuth documentation page](https://checkbook.io/docs/api/products/#oauth).
+If you wish to send requests on behalf of another user, this user will use OAuth in order to generate a key that may be used on their behalf. You can get more details on our [OAuth documentation page](https://docs.checkbook.io/docs/connect-with-oauth).
 
@@ -93,36 +93,37 @@ Once you obtain the bearer token for a user, you can use it to send API requests on its behalf:
  * __Checkbook.checks__
- 	* ```list(query, callback)``` [:book:](https://checkbook.io/docs/api/reference/#get--v3-check)
- 	* ```get(check_id, callback)``` [:book:](https://checkbook.io/docs/api/reference/#get--v3-check-check_id)
- 	* ```delete(check_id, callback)``` [:book:](https://checkbook.io/docs/api/reference/#delete--v3-check-check_id)
- 	* ```sendDigitalCheck(params, callback[, idempotencyKey])``` [:book:](https://checkbook.io/docs/api/reference/#post--v3-check-digital)
- 	* ```sendPhysicalCheck(params, callback[, idempotencyKey])``` [:book:](https://checkbook.io/docs/api/reference/#post--v3-check-physical)
+ 	* ```list(query, callback)``` [:book:](https://docs.checkbook.io/reference#get-checks)
+ 	* ```get(check_id, callback)``` [:book:](https://docs.checkbook.io/reference#get-check)
+ 	* ```delete(check_id, callback)``` [:book:](https://docs.checkbook.io/reference#delete-check)
+ 	* ```sendDigitalCheck(params, callback[, idempotencyKey])``` [:book:](https://docs.checkbook.io/reference#post-check-digital)
+ 	* ```sendPhysicalCheck(params, callback[, idempotencyKey])``` [:book:](https://docs.checkbook.io/reference#post-check-physical)
  	* ```sendMultipleChecksCSV(params, callback[, idempotencyKey])```
  	
  * __Checkbook.invoices__
- 	* ```list(query, callback)``` [:book:](https://checkbook.io/docs/api/reference/#get--v3-invoice)
- 	* ```get(invoice_id, callback)``` [:book:](https://checkbook.io/docs/api/reference/#get--v3-invoice-invoice_id)
-	* ```delete(invoice_id, callback)``` [:book:](https://checkbook.io/docs/api/reference/#delete--v3-invoice-invoice_id)
-	* ```sendInvoice(params, callback[, idempotencyKey])``` [:book:](https://checkbook.io/docs/api/reference/#post--v3-invoice)
-	* ```payInvoice(params, callback[, idempotencyKey])```
+ 	* ```list(query, callback)``` [:book:](https://docs.checkbook.io/reference#get-invoices)
+ 	* ```get(invoice_id, callback)``` [:book:](https://docs.checkbook.io/reference#get-invoice)
+	* ```delete(invoice_id, callback)``` [:book:](https://docs.checkbook.io/reference#delete-invoice)
+	* ```sendInvoice(params, callback[, idempotencyKey])``` [:book:](https://docs.checkbook.io/reference#post-invoice)
+	* ```payInvoice(params, callback[, idempotencyKey])``` [:book:](https://docs.checkbook.io/reference#post-invoice-payment)
  	
  * __Checkbook.subscriptions__
- 	* ```list(query, callback)``` [:book:](https://checkbook.io/docs/api/reference/#get--v3-subscription)
-	* ```get(subscription_id, callback)``` [:book:](https://checkbook.io/docs/api/reference/#get--v3-subscription-subscription_id)
-	* ```delete(subscription_id, callback)``` [:book:](https://checkbook.io/docs/api/reference/#delete--v3-subscription-subscription_id)
-	* ```update(subscription_id, params, callback)``` [:book:](https://checkbook.io/docs/api/reference/#put--v3-subscription-subscription_id)
-	* ```sendRecurringCheck(params, callback[, idempotencyKey])``` [:book:](https://checkbook.io/docs/api/reference/#post--v3-subscription-check)
-	* ```sendRecurringInvoice(params, callback[, idempotencyKey])``` [:book:](https://checkbook.io/docs/api/reference/#post--v3-subscription-invoice)
+ 	* ```list(query, callback)``` [:book:](https://docs.checkbook.io/reference#get-subscriptions)
+	* ```get(subscription_id, callback)``` [:book:](https://docs.checkbook.io/reference#get-subscription)
+	* ```delete(subscription_id, callback)``` [:book:](https://docs.checkbook.io/reference#delete-subscription)
+	* ```update(subscription_id, params, callback)``` [:book:](https://docs.checkbook.io/reference#put-subscription)
+	* ```sendRecurringCheck(params, callback[, idempotencyKey])``` [:book:](https://docs.checkbook.io/reference#post-subscription-check)
+	* ```sendRecurringInvoice(params, callback[, idempotencyKey])``` [:book:](https://docs.checkbook.io/reference#post-subscription-invoice)
  
  * __Checkbook.banks__
- 	* ```list(callback)``` [:book:](https://checkbook.io/docs/api/reference/#get--v3-bank)
- 	* ```institutions(callback)``` [:book:](https://checkbook.io/docs/api/reference/#get--v3-bank-institutions)
- 	* ```delete(bank_id, callback)``` [:book:](https://checkbook.io/docs/api/reference/#delete--v3-bank-bank_id)
- 	* ```instantAccountVerification(params, callback[, idempotencyKey])``` [:book:](https://checkbook.io/docs/api/reference/#post--v3-bank-iav)
- 	* ```addBankAccount(params, callback[, idempotencyKey])``` [:book:](https://checkbook.io/docs/api/reference/#post--v3-bank)
- 	* ```verifyMicrodesposits(params, callback)``` [:book:](https://checkbook.io/docs/api/reference/#post--v3-bank-verify)
+ 	* ```list(callback)``` [:book:](https://docs.checkbook.io/reference#get-banks)
+ 	* ```institutions(callback)``` [:book:](https://docs.checkbook.io/reference#get-bank-institutions)
+ 	* ```delete(bank_id, callback)``` [:book:](https://docs.checkbook.io/reference#delete-bank)
+ 	* ```instantAccountVerification(params, callback[, idempotencyKey])``` [:book:](https://docs.checkbook.io/reference#post-bank-iav)
+ 	* ```addBankAccount(params, callback[, idempotencyKey])``` [:book:](https://docs.checkbook.io/reference#post-bank)
+ 	* ```verifyMicrodesposits(params, callback)``` [:book:](https://docs.checkbook.io/reference#post-bank-verify)
  	
  * __Checkbook.users__
- 	* ```create(params, callback[, idempotencyKey])``` [:book:](https://checkbook.io/docs/api/reference/#post--v3-user)
- 	* ```update(params, callback)``` [:book:](https://checkbook.io/docs/api/reference/#put--v3-user)
- 	* ```list(query, callback)``` [:book:](https://checkbook.io/docs/api/reference/#get--v3-user-list)
+ 	* ```create(params, callback[, idempotencyKey])``` [:book:](https://docs.checkbook.io/reference#post-user)
+ 	* ```update(params, callback)``` [:book:](https://docs.checkbook.io/reference#put-user)
+ 	* ```get(callback)``` [:book:](https://docs.checkbook.io/reference#get-user)
+ 	* ```list(query, callback)``` [:book:](https://docs.checkbook.io/reference#get-users)
  
@@ -150,6 +151,6 @@ ---
 
- * [API Endpoints](https://checkbook.io/docs/api/reference/)
- * [Error Codes](https://checkbook.io/docs/api/products/#error-codes)
- * [Idempotency](https://checkbook.io/docs/api/products/#idempotent-requests)
+ * [API Endpoints](https://docs.checkbook.io/reference)
+ * [Error Codes](https://docs.checkbook.io/reference#error-codes)
+ * [Idempotency](https://docs.checkbook.io/reference#idempotent-requests)
     
     

samples/banks.js

@@ -11,3 +11,3 @@ var CheckbookAPI = require("../lib/checkbook");
  Return the bank accounts for a user
- https://checkbook.io/docs/api#get--v3-bank
+ https://docs.checkbook.io/reference#get-banks
  */
@@ -27,3 +27,3 @@ /*
  Get a list of our supported institutions for IAV (Instant Account Verification)
- https://checkbook.io/docs/api#get--v3-bank-institutions
+ https://docs.checkbook.io/reference#get-bank-institutions
  */
@@ -43,3 +43,3 @@ /*
  Remove the specified bank account for a user
- https://checkbook.io/docs/api#delete--v3-bank-(bank_id)
+ https://docs.checkbook.io/reference#delete-bank
  */
@@ -59,3 +59,3 @@ /*
  Add a new bank account for user
- https://checkbook.io/docs/api#post--v3-bank
+ https://docs.checkbook.io/reference#post-bank
  */
@@ -80,3 +80,3 @@ /*
  Verify the microdeposits for a bank account
- https://checkbook.io/docs/api#post--v3-bank-verify
+ https://docs.checkbook.io/reference#post-bank-verify
  */
@@ -83,0 +83,0 @@ /*

samples/checks.js

@@ -11,3 +11,3 @@ var CheckbookAPI = require("../lib/checkbook");
  Get sent/received checks
- https://checkbook.io/docs/api#get--v3-check
+ https://docs.checkbook.io/reference#get-checks
  */
@@ -31,3 +31,3 @@ /*
  Get the specified check
- https://checkbook.io/docs/api#get--v3-check-(check_id)
+ https://docs.checkbook.io/reference#get-check
  */
@@ -47,3 +47,3 @@ /*
  Void the specified check
- https://checkbook.io/docs/api#delete--v3-check-(check_id)
+ https://docs.checkbook.io/reference#delete-check
  */
@@ -63,3 +63,3 @@ /*
  Create a digital check
- https://checkbook.io/docs/api#post--v3-check-digital
+ https://docs.checkbook.io/reference#post-check-digital
  */
@@ -84,3 +84,3 @@ /*
  Create a digital check (with idempotency key)
- https://checkbook.io/docs/api#post--v3-check-digital
+ https://docs.checkbook.io/reference#post-check-digital
  */
@@ -105,3 +105,3 @@ /*
  Create a physical check
- https://checkbook.io/docs/api#post--v3-check-physical
+ https://docs.checkbook.io/reference#post-check-physical
  */
@@ -108,0 +108,0 @@ /*

samples/invoices.js

@@ -11,3 +11,3 @@ var CheckbookAPI = require("../lib/checkbook");
  Get sent/received invoices
- https://checkbook.io/docs/api#get--v3-invoice
+ https://docs.checkbook.io/reference#get-invoices
  */
@@ -30,3 +30,3 @@ /*
  Get the specified invoice
- https://checkbook.io/docs/api#get--v3-invoice-(invoice_id)
+ https://docs.checkbook.io/reference#get-invoice
  */
@@ -46,3 +46,3 @@ /*
  Void the specified invoice
- https://checkbook.io/docs/api#delete--v3-invoice-(invoice_id)
+ https://docs.checkbook.io/reference#delete-invoice
  */
@@ -62,3 +62,3 @@ /*
  Create invoice
- https://checkbook.io/docs/api#post--v3-invoice
+ https://docs.checkbook.io/reference#post-invoice
  */
@@ -83,3 +83,3 @@ /*
  Create invoice (with idempotency key)
- https://checkbook.io/docs/api#post--v3-invoice
+ https://docs.checkbook.io/reference#post-invoice
  */
@@ -104,3 +104,3 @@ /*
  Pay invoice
- https://checkbook.io/docs/api#post--v3-invoice
+ https://docs.checkbook.io/reference#post-invoice-payment
  */
@@ -107,0 +107,0 @@ /*

samples/subscriptions.js

@@ -11,3 +11,3 @@ var CheckbookAPI = require("../lib/checkbook");
  Return the subscriptions for a user
- https://checkbook.io/docs/api#get--v3-subscription
+ https://docs.checkbook.io/reference#get-subscriptions
  */
@@ -30,3 +30,3 @@ /*
  Get the specified subscription for a user
- https://checkbook.io/docs/api#get--v3-subscription-(subscription_id)
+ https://docs.checkbook.io/reference#get-subscription
  */
@@ -46,3 +46,3 @@ /*
  Remove the specified subscription for a user
- https://checkbook.io/docs/api#delete--v3-subscription-(subscription_id)
+ https://docs.checkbook.io/reference#delete-subscription
  */
@@ -62,3 +62,3 @@ /*
  Update the specified subscription for a user
- https://checkbook.io/docs/api#put--v3-subscription-(subscription_id)
+ https://docs.checkbook.io/reference#put-subscription
  */
@@ -80,3 +80,3 @@ /*
  Create a new check subscription
- https://checkbook.io/docs/api#post--v3-subscription-check
+ https://docs.checkbook.io/reference#post-subscription-check
  */
@@ -102,3 +102,3 @@ /*
  Create a new invoice subscription
- https://checkbook.io/docs/api#post--v3-subscription-invoice
+ https://docs.checkbook.io/reference#post-subscription-invoice
  */
@@ -105,0 +105,0 @@ /*

samples/users.js

@@ -11,3 +11,3 @@ var CheckbookAPI = require("../lib/checkbook");
  Create a new user (with idempotency key)
- https://checkbook.io/docs/api#post--v3-user
+ https://docs.checkbook.io/reference#post-user
  */
@@ -30,3 +30,3 @@ /*
  Update a user
- https://checkbook.io/docs/api#put--v3-user
+ https://docs.checkbook.io/reference#put-user
  */
@@ -53,4 +53,19 @@ /*
 /*
+ Get user information
+ https://docs.checkbook.io/reference#get-user
+ */
+/*
+Checkbook.users.get(function (error, response) {
+    if (error) {
+        console.log('Error:', error);
+    } else {
+        console.log('Response:', response);
+    }
+});
+*/
+
+
+/*
  Get the marketplace users
- https://checkbook.io/docs/api/reference/#get--v3-user-list
+ https://docs.checkbook.io/reference#get-users
  */
@@ -57,0 +72,0 @@ /*

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

148119

increased by0.11%

Lines of code

732

increased by2.66%

Number of lines in readme file

153

increased by0.66%

Dependency changes

• Updatedlodash@^4.17.11