@veryfi/veryfi-sdk 1.2.2 → 1.2.4

package/README.md

@@ -1,11 +1,12 @@
 # Veryfi SDK for Node.js
 
+<img src="https://user-images.githubusercontent.com/30125790/212157461-58bdc714-2f89-44c2-8e4d-d42bee74854e.png#gh-dark-mode-only" width="200">
+<img src="https://user-images.githubusercontent.com/30125790/212157486-bfd08c5d-9337-4b78-be6f-230dc63838ba.png#gh-light-mode-only" width="200">
+
 [![Node.js - version](https://img.shields.io/badge/node-%3E%3D%206.0.0-brightgreen)](https://www.npmjs.com/package/@veryfi/veryfi-sdk)
 [![npm](https://img.shields.io/badge/npm-v7.0.0-blue)](https://www.npmjs.com/package/@veryfi/veryfi-sdk)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 
-![Veryfi Logo](https://cdn.veryfi.com/logos/veryfi-logo-wide-github.png)
-
 ## Table of Contents
 
 - [Veryfi SDK for Node.js](#veryfi-sdk-for-nodejs)
@@ -62,15 +63,17 @@ This submits a document for processing (3-5 seconds for a response)
 
 ```js
 let veryfi_client = new Client(client_id, client_secret, username, api_key);
-let response = veryfi_client.process_document(file_path, categories=categories);
-console.log(response);
+let response = veryfi_client.process_document(file_path, categories=categories).then(response => {
+  console.log(response)
+});
 ```
 
 ...or with a URL
 
 ```js
-let response = veryfi_client.process_document_url(url, external_id=some_id);
-console.log(response);
+let response = veryfi_client.process_document_url(url, external_id=some_id).then(response => {
+  console.log(response)
+});
 ```
 
 ### Response
@@ -238,7 +241,10 @@ veryfi_client.update_document(id=12345,
         'vendor': new_vendor,
         'category': new_category,
         'total': new_total
-    });
+    })
+.then(response => {
+  console.log(response)
+});
 ```
 
 ## Need help?

package/lib/main.js

@@ -1,13 +1,15 @@
 const {createHmac} = require('crypto');
 const axios = require('axios').default;
 const path = require('path');
+const FormData = require('form-data');
 const fs = require('fs');
+const {promisify} = require("util");
 
 /**
  * Create instance of a Client
  * @class
  * @param {string} client_id Your Veryfi client id
- * @param {string} client_secret Your Veryfi client secret
+ * @param {string | undefined} client_secret Your Veryfi client secret
  * @param {string} username Your Veryfi username
  * @param {string} api_key Your Veryfi API key
  * @param {string} base_url
@@ -21,12 +23,13 @@ function Client(
     api_key,
     base_url = "https://api.veryfi.com/",
     api_version = "v8",
-    timeout = 120,) {
+    timeout = 120) {
     this.client_id = client_id;
     this.client_secret = client_secret;
     this.username = username;
     this.api_key = api_key;
     this.base_url = base_url;
+    this.timeout = timeout;
     this.api_version = api_version;
     this.CATEGORIES = [
         "Advertising & Marketing",
@@ -50,7 +53,7 @@ function Client(
 /**
  * Check api version for w2 documents
  * @private
- * @throws if api_version is different to v8
+ * @throws error when api_version is different to v8
  */
 Client.prototype._check_w2_version = function () {
     if (this.api_version !== "v8") throw Error("w2 is only supported on v8")
@@ -64,7 +67,7 @@ Client.prototype._check_w2_version = function () {
  */
 Client.prototype._get_headers = function (has_files = false) {
     let final_headers = {
-        "User-Agent": "Node.js Veryfi-Nodejs/1.2.0",
+        "User-Agent": "Node.js Veryfi-Nodejs/1.2.4",
         "Accept": "application/json",
         "Content-Type": "application/json",
         "Client-Id": this.client_id,
@@ -117,11 +120,10 @@ Client.prototype._generate_signature = function (payload_params, timestamp) {
  * @param {string} endpoint_name Endpoint name such as 'documents', 'users', etc.
  * @param {{}} request_arguments JSON payload to send to Veryfi
  * @param params {{}} query params.
- * @param file_stream file stream of the document
+ * @param {Boolean} has_files Are there any files to be submitted as binary
  * @returns {JSON} A JSON of the response data.
  */
-Client.prototype._request = async function (http_verb, endpoint_name, request_arguments, params = {}, file_stream = null) {
-    let has_files = (Boolean(file_stream));
+Client.prototype._request = async function (http_verb, endpoint_name, request_arguments, params = {}, has_files = false) {
     let headers = this._get_headers(has_files);
     let api_url = `${this._get_url()}/partner${endpoint_name}`;
 
@@ -134,12 +136,21 @@ Client.prototype._request = async function (http_verb, endpoint_name, request_ar
         });
     }
 
-    if (has_files === false) {
-        request_arguments = JSON.stringify(request_arguments);
+    if (has_files) {
+        const formData = new FormData();
+        for (const key in request_arguments) {
+            if (request_arguments.hasOwnProperty(key)) {
+                const value = request_arguments[key];
+                formData.append(key, value);
+            }
+        }
+        headers = Object.assign(headers, formData.getHeaders());
+        const getLength = promisify(formData.getLength).bind(formData);
+        headers['Content-Length'] = await getLength()
+        request_arguments = formData;
     } else {
-        Object.assign(headers, {...request_arguments});
+        request_arguments = JSON.stringify(request_arguments);
     }
-
     try {
         return await axios.request({
             method: http_verb,
@@ -150,9 +161,10 @@ Client.prototype._request = async function (http_verb, endpoint_name, request_ar
             params: params
         });
     } catch (response) {
-        let errorStatus = response['response']['status'];
-        let errorInfo = response['response']['data']['error'];
-        throw new Error(errorStatus + errorInfo);
+        let errorStatus = response?.response?.status;
+        let errorInfo = response?.response?.data?.error;
+        let message = response?.message;
+        throw new Error(`Error: ${errorStatus} ${errorInfo} ${message}`);
     }
 }
 
@@ -211,7 +223,7 @@ Client.prototype.process_document = async function (
     if (!categories) {
         categories = this.CATEGORIES;
     }
-    let file_name = path.basename(file_path)
+    let file_name = path.basename(file_path);
     const image_file = fs.readFileSync(file_path, {encoding: 'base64'});
     const base64_encoded_string = Buffer.from(image_file).toString('utf-8');
     let request_arguments = {
@@ -220,29 +232,65 @@ Client.prototype.process_document = async function (
         "categories": categories,
         "auto_delete": delete_after_processing,
     };
-    request_arguments = Object.assign(request_arguments, kwargs)
-    let document = await this._request("POST", endpoint_name, request_arguments)
+    request_arguments = Object.assign(request_arguments, kwargs);
+    let document = await this._request("POST", endpoint_name, request_arguments);
     return document['data'];
 }
 
 /**
  * Process a document and extract all the fields from it
  * @example
- * veryfi_client.process_document_buffer('base64_encoded_string',
+ * veryfi_client.process_document_stream('ReadStream',
  *                                'receipt.png',
  *                                ['Entertainment','Food'],
  *                                true,
  *                                {'extra': 'parameters'})
  *
  * @memberof Client
- * @param {String} base64_encoded_string Buffer of a file to submit for data extraction
+ * @param {ReadStream} file ReadStream of a file to submit for data extraction
  * @param {String} file_name The file name including the extension
  * @param {Array} categories List of categories Veryfi can use to categorize the document
  * @param {Boolean} delete_after_processing Delete this document from Veryfi after data has been extracted
  * @param {Object} kwargs Additional request parameters
  * @returns {JSON} Data extracted from the document
  */
-Client.prototype.process_document_buffer = async function (
+Client.prototype.process_document_stream = async function (
+    file,
+    file_name,
+    delete_after_processing = false,
+    {...kwargs} = {}
+) {
+
+    let endpoint_name = "/documents/";
+
+    let request_arguments = {
+        "file_name": file_name,
+        "file": file,
+        "auto_delete": delete_after_processing.toString(),
+    };
+    request_arguments = Object.assign(request_arguments, kwargs);
+    let document = await this._request("POST", endpoint_name, request_arguments, {}, true);
+    return document['data'];
+}
+
+/**
+ * Process a document and extract all the fields from it
+ * @example
+ * veryfi_client.process_document_base64string('base64_encoded_string',
+ *                                'receipt.png',
+ *                                ['Entertainment','Food'],
+ *                                true,
+ *                                {'extra': 'parameters'})
+ *
+ * @memberof Client
+ * @param {String} base64_encoded_string Buffer string of a file to submit for data extraction
+ * @param {String} file_name The file name including the extension
+ * @param {Array} categories List of categories Veryfi can use to categorize the document
+ * @param {Boolean} delete_after_processing Delete this document from Veryfi after data has been extracted
+ * @param {Object} kwargs Additional request parameters
+ * @returns {JSON} Data extracted from the document
+ */
+Client.prototype.process_document_base64string = async function (
     base64_encoded_string,
     file_name,
     categories = null,
@@ -260,8 +308,8 @@ Client.prototype.process_document_buffer = async function (
         "categories": categories,
         "auto_delete": delete_after_processing,
     };
-    request_arguments = Object.assign(request_arguments, kwargs)
-    let document = await this._request("POST", endpoint_name, request_arguments)
+    request_arguments = Object.assign(request_arguments, kwargs);
+    let document = await this._request("POST", endpoint_name, request_arguments);
     return document['data'];
 }
 
@@ -304,7 +352,7 @@ Client.prototype.process_document_url = async function (
         "file_urls": file_urls,
         "max_pages_to_process": max_pages_to_process,
     };
-    request_arguments = Object.assign(request_arguments, kwargs)
+    request_arguments = Object.assign(request_arguments, kwargs);
     let response = await this._request("POST", endpoint_name, request_arguments);
     return response['data'];
 }
@@ -344,15 +392,15 @@ Client.prototype.update_document = async function (document_id, {...kwargs} = {}
  * @return {Array} An array of JSON with all w2 documents.
  */
 Client.prototype.get_w2_documents = async function (page = null) {
-    this._check_w2_version()
-    let endpoint_name = "/w2s/"
-    let request_arguments = {}
-    let params = {}
+    this._check_w2_version();
+    let endpoint_name = "/w2s/";
+    let request_arguments = {};
+    let params = {};
     if (page !== null) {
-        params = {"page": page}
+        params = {"page": page};
     }
-    let response = await this._request("GET", endpoint_name, request_arguments, params)
-    return response['data']['results']
+    let response = await this._request("GET", endpoint_name, request_arguments, params);
+    return response['data']['results'];
 }
 
 /**
@@ -364,11 +412,11 @@ Client.prototype.get_w2_documents = async function (page = null) {
 Client.prototype.get_w2_document = async function (
     document_id,
 ) {
-    this._check_w2_version()
-    let endpoint_name = `/w2s/${document_id}/`
-    let request_arguments = {"id": document_id}
-    let response = await this._request("GET", endpoint_name, request_arguments)
-    return response['data']
+    this._check_w2_version();
+    let endpoint_name = `/w2s/${document_id}/`;
+    let request_arguments = {"id": document_id};
+    let response = await this._request("GET", endpoint_name, request_arguments);
+    return response['data'];
 }
 
 /**
@@ -396,9 +444,9 @@ Client.prototype.process_w2_document_from_buffer = async function (
         "auto_delete": delete_after_processing,
         "max_pages_to_process": max_pages_to_process,
     }
-    request_arguments = Object.assign(request_arguments, kwargs)
-    let response = await this._request("POST", endpoint_name, request_arguments)
-    return response['data']
+    request_arguments = Object.assign(request_arguments, kwargs);
+    let response = await this._request("POST", endpoint_name, request_arguments);
+    return response['data'];
 }
 
 /**
@@ -424,7 +472,7 @@ Client.prototype.process_w2_document = async function (
         delete_after_processing,
         max_pages_to_process,
         kwargs
-    )
+    );
 }
 
 /**
@@ -456,11 +504,38 @@ Client.prototype.process_w2_document_from_url = async function (
         "file_urls": file_urls,
         "max_pages_to_process": max_pages_to_process
     }
-    request_arguments = Object.assign(request_arguments, kwargs)
-    let response = await this._request("POST", endpoint_name, request_arguments)
-    return response['data']
+    request_arguments = Object.assign(request_arguments, kwargs);
+    let response = await this._request("POST", endpoint_name, request_arguments);
+    return response['data'];
 }
 
+/**
+ * Add a new tag on an existing document
+ *
+ * @param {number} document_id ID of the document you'd like to add a Tag
+ * @param {string} tag name to add
+ * @return {JSON} response about tag added.
+ */
+Client.prototype.add_tag = async function (document_id, tag) {
+    let endpoint_name = `/documents/${document_id}/tags/`;
+    let request_arguments = {"name": tag};
+    let response = await this._request("PUT", endpoint_name, request_arguments);
+    return response['data'];
+}
+
+/**
+ * Delete all the tags on an existing document
+ *
+ * @param {number} document_id ID of the document you'd like to delete tags
+ * @return {JSON} response about deleted tags.
+ */
+Client.prototype.delete_tags = async function (document_id) {
+    let endpoint_name = `/documents/${document_id}/tags/`;
+    let request_arguments = {};
+    return this._request("DELETE", endpoint_name, request_arguments);
+}
+
+
 // Exports
 
 module.exports = Client;

package/lib/types/main.d.ts

@@ -1,3 +1,5 @@
+import fs from "fs";
+
 /**
  * Additional request parameters type
  */
@@ -44,6 +46,7 @@ export declare type VeryfiDocument = {
   payment_display_name?: null | string;
   payment_terms?: null | string;
   payment_type?: null | string;
+  pdf_url?: null | string;
   phone_number?: null | string;
   purchase_order_number?: null | string;
   rounding?: null | number;
@@ -122,12 +125,17 @@ declare type Payment = {
   type?: null | string;
 };
 
+declare type Tag = {
+  id?: null | number;
+  name?: null | string;
+};
+
 export declare class Client {
   /**
    * Create instance of a Client
    * @class
    * @param {string} client_id Your Veryfi client id
-   * @param {string} client_secret Your Veryfi client secret
+   * @param {string | undefined} client_secret Your Veryfi client secret
    * @param {string} username Your Veryfi username
    * @param {string} api_key Your Veryfi API key
    * @param {string} base_url
@@ -136,7 +144,7 @@ export declare class Client {
    */
   constructor(
     client_id: string,
-    client_secret: string,
+    client_secret: string | undefined,
     username: string,
     api_key: string,
     base_url?: string,
@@ -146,7 +154,7 @@ export declare class Client {
 
   client_id: string;
 
-  client_secret: string;
+  client_secret: string | undefined;
 
   username: string;
 
@@ -181,6 +189,56 @@ export declare class Client {
    */
   public get_document(document_id: string): Promise<VeryfiDocument>;
 
+  /**
+   * Process a document and extract all the fields from it
+   * @example
+   * veryfi_client.process_document_buffer('buffer',
+   *                                'receipt.png',
+   *                                ['Entertainment','Food'],
+   *                                true,
+   *                                {'extra': 'parameters'})
+   *
+   * @memberof Client
+   * @param {ReadStream} file ReadStream of a file to submit for data extraction
+   * @param {String} file_name The file name including the extension
+   * @param {Array} categories List of categories Veryfi can use to categorize the document
+   * @param {Boolean} delete_after_processing Delete this document from Veryfi after data has been extracted
+   * @param {Object} kwargs Additional request parameters
+   * @returns {JSON} Data extracted from the document
+   */
+  public process_document_stream(
+      file: fs.ReadStream,
+      file_name: string,
+      categories?: string[],
+      delete_after_processing?: boolean,
+      { ...kwargs }?: VeryfiExtraArgs
+  ): Promise<VeryfiDocument>;
+
+  /**
+   * Process a document and extract all the fields from it
+   * @example
+   * veryfi_client.process_document_buffer_string('base64_encoded_string',
+   *                                'receipt.png',
+   *                                ['Entertainment','Food'],
+   *                                true,
+   *                                {'extra': 'parameters'})
+   *
+   * @memberof Client
+   * @param {String} base64_encoded_string Buffer string of a file to submit for data extraction
+   * @param {String} file_name The file name including the extension
+   * @param {Array} categories List of categories Veryfi can use to categorize the document
+   * @param {Boolean} delete_after_processing Delete this document from Veryfi after data has been extracted
+   * @param {Object} kwargs Additional request parameters
+   * @returns {JSON} Data extracted from the document
+   */
+  public process_document_base64string(
+      base64_encoded_string: string,
+      file_name: string,
+      categories?: string[],
+      delete_after_processing?: boolean,
+      { ...kwargs }?: VeryfiExtraArgs
+  ): Promise<VeryfiDocument>;
+
   /**
    * Process a document and extract all the fields from it
    * @example
@@ -234,10 +292,10 @@ export declare class Client {
    * @param {string} document_id ID of the document you'd like to delete
    * @returns {Promise<VeryfiDocument>} Object of data extracted from the document
    */
-  public delete_document(document_id: string): Promise<VeryfiDocument>;
+  public delete_document(document_id: string): Promise<any>;
 
   /**
-   * Update data for a previously processed document, including almost any field like `vendor`, `date`, `notes` and etc.
+   * Update data for a previously processed document, including almost any field like `vendor`, `date`, `notes` etc.
    * @example
    * veryfi_client.update_document(
    *   id,
@@ -252,13 +310,31 @@ export declare class Client {
     document_id: string,
     { ...kwargs }?: VeryfiExtraArgs
   ): Promise<VeryfiDocument>;
+
+  /**
+   * Add a new tag on an existing document
+   *
+   * @param {number} document_id ID of the document you'd like to add a Tag
+   * @param {string} tag name to add
+   * @return {Promise<Tag>} response about tag added.
+   */
+  public add_tag(document_id: string, tag: string): Promise<Tag>;
+
+  /**
+   * Delete all tags on an existing document
+   *
+   * @param {number} document_id ID of the document you'd like to delete all Tags
+   * @return {Promise<any>} response about deleted tags.
+   */
+  public delete_tags(document_id: string): Promise<any>;
+
 }
 
 /**
  * Create instance of a Client
  * @class
  * @param {string} client_id Your Veryfi client id
- * @param {string} client_secret Your Veryfi client secret
+ * @param {string | undefined} client_secret Your Veryfi client secret
  * @param {string} username Your Veryfi username
  * @param {string} api_key Your Veryfi API key
  * @param {string} base_url
@@ -267,7 +343,7 @@ export declare class Client {
  */
 export declare function Client(
   client_id: string,
-  client_secret: string,
+  client_secret: string | undefined,
   username: string,
   api_key: string,
   base_url?: string,

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@veryfi/veryfi-sdk",
-  "version": "1.2.2",
+  "version": "1.2.4",
   "description": "Node.js module for communicating with the Veryfi OCR API",
   "main": "lib/main.js",
-  "typings": "types/main.d.ts",
+  "typings": "lib/types/main.d.ts",
   "scripts": {
     "test": "jest",
     "doc": "jsdoc -d docs --configure jsconf.json main.js",
@@ -35,6 +35,7 @@
     "@jest/globals": "^29.0.3",
     "axios": "^0.21.1",
     "docdash": "^1.2.0",
+    "form-data": "^4.0.0",
     "jest-config": "^29.0.3"
   },
   "repository": {