@veryfi/veryfi-sdk 1.2.3 → 1.2.5

package/README.md

@@ -38,7 +38,7 @@ You may need to run the above command with `sudo`.
 
 ### Obtaining Client ID and user keys
 
-If you don't have an account with Veryfi, please go ahead and register here: [https://hub.veryfi.com/signup/api/](https://hub.veryfi.com/signup/api/)
+If you don't have an account with Veryfi, please go ahead and register here: [https://app.veryfi.com/signup/api/](https://app.veryfi.com/signup/api/)
 
 ### Node.js API Client Library
 
@@ -248,11 +248,14 @@ veryfi_client.update_document(id=12345,
 ```
 
 ## Need help?
+Visit https://docs.veryfi.com/ to access integration guides and usage notes in the Veryfi API Documentation Portal
 
 If you run into any issue or need help installing or using the library, please contact support@veryfi.com.
 
 If you found a bug in this library or would like new features added, then open an issue or pull requests against this repo!
 
+### [API Docs](https://docs.veryfi.com/)
+
 ### [Learn more at our blog](https://www.veryfi.com/nodejs/)
 
 ## Tutorial Video

package/lib/main.js

@@ -1,7 +1,9 @@
 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
@@ -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",
@@ -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.3",
+        "User-Agent": "Node.js Veryfi-Nodejs/1.2.5",
         "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}`);
     }
 }
 
@@ -228,21 +240,57 @@ Client.prototype.process_document = async function (
 /**
  * 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 {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_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 of a file to submit for data extraction
+ * @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_buffer = async function (
+Client.prototype.process_document_base64string = async function (
     base64_encoded_string,
     file_name,
     categories = null,
@@ -487,6 +535,34 @@ Client.prototype.delete_tags = async function (document_id) {
     return this._request("DELETE", endpoint_name, request_arguments);
 }
 
+/**
+ * Replace multiple tags on an existing document
+ *
+ * @param {number} document_id ID of the document you'd like to add a Tag
+ * @param {string[]} tags array of tags to be added
+ * @return {JSON} response about tag added.
+ */
+Client.prototype.replace_tags = async function (document_id, tags) {
+    let endpoint_name = `/documents/${document_id}/`;
+    let request_arguments = {"tags": tags};
+    let response = await this._request("PUT", endpoint_name, request_arguments);
+    return response['data'];
+}
+
+/**
+ * Add multiple tags on an existing document
+ *
+ * @param {number} document_id ID of the document you'd like to add a Tag
+ * @param {string[]} tags array of tags to be added
+ * @return {JSON} response about tag added.
+ */
+Client.prototype.add_tags = async function (document_id, tags) {
+    let endpoint_name = `/documents/${document_id}/tags/`;
+    let request_arguments = {"tags": tags};
+    let response = await this._request("POST", endpoint_name, request_arguments);
+    return response['data'];
+}
+
 
 // Exports
 

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;
@@ -186,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
@@ -275,6 +328,24 @@ export declare class Client {
    */
   public delete_tags(document_id: string): Promise<any>;
 
+  /**
+   * Add multiple tags on an existing document
+   *
+   * @param {number} document_id ID of the document you'd like to add a Tag
+   * @param {string[]} tags name to add
+   * @return {Promise<Tag>} response about tags added.
+   */
+  public add_tags(document_id: string, tags: string[]): Promise<Tag>;
+
+  /**
+   * Replace multiple tags on an existing document
+   *
+   * @param {number} document_id ID of the document you'd like to add a Tag
+   * @param {string[]} tags names to be added
+   * @return {Promise<Tag>} response about tags added.
+   */
+  public replace_tags(document_id: string, tags: string[]): Promise<Tag>;
+
 }
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@veryfi/veryfi-sdk",
-  "version": "1.2.3",
+  "version": "1.2.5",
   "description": "Node.js module for communicating with the Veryfi OCR API",
   "main": "lib/main.js",
   "typings": "lib/types/main.d.ts",
@@ -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": {