@veryfi/veryfi-sdk 1.3.2 → 1.4.1

package/lib/w9s/getW9.js

@@ -0,0 +1,24 @@
+const Client = require('../client/constructor');
+/**
+ * Get a w9 document https://docs.veryfi.com/api/w9s/get-a-w-9/
+ * @memberof Client
+ * @param {number} document_id The unique identifier of the document.
+ * @param {boolean} bounding_boxes A field used to determine whether to return bounding_box and bounding_region for extracted fields in the Document response.
+ * @param {boolean} confidence_details A field used to determine whether to return the score and ocr_score fields in the Document response.
+ * @param {Object} kwargs Additional request parameters
+ * @returns {JSON} Object of a previously processed blueprinted document.
+ */
+Client.prototype.get_w9 = async function (
+    document_id,
+    bounding_boxes = false,
+    confidence_details = false,
+    {...kwargs} = {}
+) {
+    let endpoint_name = `/w9s/${document_id}/`;
+    let request_arguments = {
+        "bounding_boxes": bounding_boxes,
+        "confidence_details": confidence_details
+    };
+    let document = await this._request("GET", endpoint_name, request_arguments, kwargs, false);
+    return document['data'];
+}

package/lib/w9s/getW9s.js

@@ -0,0 +1,28 @@
+const Client = require('../client/constructor');
+/**
+ * Get all w9 documents. https://docs.veryfi.com/api/w9s/get-w-9-s/
+ * @memberof Client
+ * @param {number} page The page number. The response is capped to maximum of 50 results per page.
+ * @param {number} page_size The number of Documents per page.
+ * @param {boolean} bounding_boxes A field used to determine whether to return bounding_box and bounding_region for extracted fields in the Document response.
+ * @param {boolean} confidence_details A field used to determine whether to return the score and ocr_score fields in the Document response.
+ * @param {Object} kwargs Additional request parameters
+ * @returns {JSON} Object of previously processed any documents
+ */
+Client.prototype.get_w9s = async function (
+    page = 1,
+    page_size = 50,
+    bounding_boxes = false,
+    confidence_details = false,
+    {...kwargs} = {}
+) {
+    let endpoint_name = `/w9s/`;
+    let request_arguments = {
+        "page": page,
+        "page_size": page_size,
+        "bounding_boxes": bounding_boxes,
+        "confidence_details": confidence_details
+    };
+    let document = await this._request("GET", endpoint_name, request_arguments, kwargs, false);
+    return document['data'];
+}

package/lib/w9s/processW9.js

@@ -0,0 +1,30 @@
+const Client = require('../client/constructor');
+const path = require('path');
+const fs = require('fs');
+/**
+ * Upload a w9 document from a file path. https://docs.veryfi.com/api/w9s/process-a-w-9/
+ * @memberof Client
+ * @param {String} file_path Path on disk to a file to submit for data extraction
+ * @param {boolean} bounding_boxes A field used to determine whether to return bounding_box and bounding_region for extracted fields in the Document response.
+ * @param {boolean} confidence_details A field used to determine whether to return the score and ocr_score fields in the Document response.
+ * @param {Object} kwargs Additional request parameters
+ * @returns {JSON} Data extracted from the document
+ */
+Client.prototype.process_w9 = async function (
+    file_path,
+    bounding_boxes = false,
+    confidence_details = false,
+    {...kwargs} = {}
+) {
+
+    let file = fs.createReadStream(file_path);
+    let file_name = path.basename(file_path);
+
+    return this.process_w9_from_stream(
+        file,
+        file_name,
+        bounding_boxes,
+        confidence_details,
+        kwargs
+    );
+}

package/lib/w9s/processW9Base64.js

@@ -0,0 +1,31 @@
+const Client = require('../client/constructor');
+/**
+ * Upload a w9 document from a buffer. https://docs.veryfi.com/api/w9s/process-a-w-9/
+ * @memberof Client
+ * @param {String} file_name The file name including the extension
+ * @param {String} file_base64_string To submit a file for data extraction, encode the file in Base64 format and ensure it includes the MIME type. The Base64 string should follow this structure: data:${mimeType};base64,${base64String}
+ * @param {boolean} bounding_boxes A field used to determine whether to return bounding_box and bounding_region for extracted fields in the Document response.
+ * @param {boolean} confidence_details A field used to determine whether to return the score and ocr_score fields in the Document response.
+ * @param {Object} kwargs Additional request parameters
+ * @returns {JSON} Data extracted from the document
+ */
+Client.prototype.process_w9_from_base64 = async function (
+    file_name,
+    file_base64_string,
+    bounding_boxes = false,
+    confidence_details = false,
+    {...kwargs} = {}
+) {
+    
+    let endpoint_name = "/w9s/";
+    let request_arguments = {
+        "file_name": file_name,
+        "file_data": file_base64_string,
+        "bounding_boxes": bounding_boxes,
+        "confidence_details": confidence_details,
+    };
+    request_arguments = Object.assign(request_arguments, kwargs);
+    let document = await this._request("POST", endpoint_name, request_arguments);
+    return document['data'];
+}
+

package/lib/w9s/processW9Stream.js

@@ -0,0 +1,31 @@
+const Client = require('../client/constructor');
+/**
+ * Upload a w9 document from a buffer. https://docs.veryfi.com/api/w9s/process-a-w-9/
+ * @memberof Client
+ * @param {fs.ReadStream} file file to submit for data extraction
+ * @param {String} file_name The file name including the extension
+ * @param {boolean} bounding_boxes A field used to determine whether to return bounding_box and bounding_region for extracted fields in the Document response.
+ * @param {boolean} confidence_details A field used to determine whether to return the score and ocr_score fields in the Document response.
+ * @param {Object} kwargs Additional request parameters
+ * @returns {JSON} Data extracted from the document
+ */
+Client.prototype.process_w9_from_stream = async function (
+    file,
+    file_name,
+    bounding_boxes = false,
+    confidence_details = false,
+    {...kwargs} = {}
+) {
+
+    let endpoint_name = "/w9s/";
+    let request_arguments = {
+        "file": file,
+        "file_name": file_name,
+        "bounding_boxes": bounding_boxes,
+        "confidence_details": confidence_details,
+    };
+    request_arguments = Object.assign(request_arguments, kwargs);
+    let document = await this._request("POST", endpoint_name, request_arguments, null, true);
+    return document['data'];
+}
+

package/lib/w9s/processW9Url.js

@@ -0,0 +1,27 @@
+const Client = require('../client/constructor');
+/**
+ * Process a w9 document from an url. https://docs.veryfi.com/api/w9s/process-a-w-9/
+ * @memberof Client
+ * @param {String} file_url url file to submit for data extraction
+ * @param {boolean} bounding_boxes A field used to determine whether to return bounding_box and bounding_region for extracted fields in the Document response.
+ * @param {boolean} confidence_details A field used to determine whether to return the score and ocr_score fields in the Document response.
+ * @param {Object} kwargs Additional request parameters
+ * @returns {JSON} Data extracted from the document
+ */
+Client.prototype.process_w9_from_url = async function (
+    file_url,
+    bounding_boxes = false,
+    confidence_details = false,
+    {...kwargs} = {}
+) {
+
+    let endpoint_name = "/w9s/";
+    let request_arguments = {
+        "file_url": file_url,
+        "bounding_boxes": bounding_boxes,
+        "confidence_details": confidence_details,
+    };
+    request_arguments = Object.assign(request_arguments, kwargs);
+    let document = await this._request("POST", endpoint_name, request_arguments, null, false);
+    return document['data'];
+}

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@veryfi/veryfi-sdk",
-  "version": "1.3.2",
+  "version": "1.4.1",
   "description": "Node.js module for communicating with the Veryfi OCR API",
-  "main": "lib/main.js",
-  "typings": "lib/types/main.d.ts",
+  "main": "lib/client/client.js",
+  "typings": "lib/types/Client.ts",
   "scripts": {
     "test": "jest",
     "doc": "jsdoc -d docs --configure jsconf.json main.js",
@@ -33,7 +33,7 @@
   },
   "dependencies": {
     "@jest/globals": "^29.0.3",
-    "axios": "^1.7.2",
+    "axios": "^1.7.4",
     "docdash": "^1.2.0",
     "form-data": "^4.0.0",
     "jest-config": "^29.0.3"