@veryfi/veryfi-sdk 1.4.0 → 1.4.2

package/lib/anydocs/processAnyDocumentStream.js

@@ -5,7 +5,7 @@ const Client = require('../client/constructor');
  * veryfi_client.process_any_document('file/path','blue_print')
  *
  * @memberof Client
- * @param {ReadStream} file ReadStream of a file to submit for data extraction
+ * @param {stream.Readable} file ReadStream of a file to submit for data extraction
  * @param {String} file_name The file name including the extension
  * @param {String} blueprint_name The name of the extraction blueprints to use.
  * @param {number} max_pages_to_process The number of pages to process for the document. The limit is 50 pages per document.

package/lib/bankstatements/processBankStatementStream.js

@@ -3,7 +3,7 @@ const Client = require('../client/constructor');
  * Process bank statement and extract all the fields from it. https://docs.veryfi.com/api/bank-statements/process-a-bank-statement/
  *
  * @memberof Client
- * @param {fs.ReadStream} file file to submit for data extraction
+ * @param {stream.Readable} 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.

package/lib/businesscards/processBusinessCardStream.js

@@ -3,7 +3,7 @@ const Client = require('../client/constructor');
  * Process Business card and extract all the fields from it. https://docs.veryfi.com/api/business-cards/process-a-business-card/
  *
  * @memberof Client
- * @param {fs.ReadStream} file file to submit for data extraction
+ * @param {stream.Readable} file file to submit for data extraction
  * @param {String} file_name The file name including the extension
  * @param {Object} kwargs Additional request parameters
  * @returns {JSON} Data extracted from the document

package/lib/checks/processCheckStream.js

@@ -3,7 +3,7 @@ const Client = require('../client/constructor');
  * Process Check and extract all the fields from it. https://docs.veryfi.com/api/bank-statements/process-a-bank-statement/
  *
  * @memberof Client
- * @param {fs.ReadStream} file file to submit for data extraction
+ * @param {stream.Readable} 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.

package/lib/client/getHeaders.js

@@ -8,7 +8,7 @@ const Client = require('../client/constructor');
  */
 Client.prototype._get_headers = function (has_files = false) {
     let final_headers = {
-        "User-Agent": "Node.js Veryfi-Nodejs/1.4.0",
+        "User-Agent": "Node.js Veryfi-Nodejs/1.4.2",
         "Accept": "application/json",
         "Content-Type": "application/json",
         "Client-Id": this.client_id,

package/lib/documents/processDocumentStream.js

@@ -9,7 +9,7 @@ const Client = require('../client/constructor');
  *                                {'extra': 'parameters'})
  *
  * @memberof Client
- * @param {ReadStream} file ReadStream of a file to submit for data extraction
+ * @param {stream.Readable} file ReadStream of a file to submit for data extraction
  * @param {String} file_name The file name including the extension
  * @param {Boolean} auto_delete Delete this document from Veryfi after data has been extracted
  * @param {Object} kwargs Additional request parameters

package/lib/types/Client.ts

@@ -2,6 +2,7 @@ import fs from "fs";
 import {VeryfiDocument} from "./VeryfiDocument";
 import {JsonObject, VeryfiExtraArgs} from "./VeryfiExtraArgs";
 import {Tag} from "./Tag";
+import * as stream from "node:stream";
 
 export declare class Client {
     /**
@@ -134,7 +135,7 @@ export declare class Client {
      * Process a document and extract all the fields from it. https://docs.veryfi.com/api/receipts-invoices/process-a-document/
      *
      * @memberof Client
-     * @param {fs.ReadStream} file ReadStream of a file to submit for data extraction
+     * @param {stream.Readable} 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} auto_delete Delete this document from Veryfi after data has been extracted
@@ -142,7 +143,7 @@ export declare class Client {
      * @returns {JSON} Data extracted from the document
      */
     public process_document_from_stream(
-        file: fs.ReadStream,
+        file: stream.Readable,
         file_name: string,
         categories?: string[],
         auto_delete?: boolean,
@@ -253,7 +254,7 @@ export declare class Client {
      * Process any document and extract all the fields from it. https://docs.veryfi.com/api/anydocs/process-%E2%88%80-doc/
      *
      * @memberof Client
-     * @param {ReadStream} file ReadStream of a file to submit for data extraction
+     * @param {stream.Readable} file ReadStream of a file to submit for data extraction
      * @param {String} file_name The file name including the extension
      * @param {String} blueprint_name The name of the extraction blueprints to use.
      * @param {number} max_pages_to_process The number of pages to process for the document. The limit is 50 pages per document.
@@ -261,7 +262,7 @@ export declare class Client {
      * @returns {JSON} Data extracted from the document
      */
     public process_any_document_from_stream(
-        file: fs.ReadStream,
+        file: stream.Readable,
         file_name: string,
         blueprint_name?: string,
         max_pages_to_process?: number,
@@ -368,7 +369,7 @@ export declare class Client {
      * Process bank statement and extract all the fields from it. https://docs.veryfi.com/api/bank-statements/process-a-bank-statement/
      *
      * @memberof Client
-     * @param {fs.ReadStream} file file to submit for data extraction
+     * @param {stream.Readable} 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.
@@ -376,7 +377,7 @@ export declare class Client {
      * @returns {JSON} Data extracted from the document
      */
     public process_bank_statement_from_stream(
-        file: fs.ReadStream,
+        file: stream.Readable,
         file_name: string,
         bounding_boxes?: boolean,
         confidence_details?: boolean,
@@ -482,13 +483,13 @@ export declare class Client {
      * Process business card and extract all the fields from it. https://docs.veryfi.com/api/business-cards/process-a-business-card/
      *
      * @memberof Client
-     * @param {fs.ReadStream} file ReadStream of a file to submit for data extraction
+     * @param {stream.Readable} file ReadStream of a file to submit for data extraction
      * @param {String} file_name The file name including the extension
      * @param {Object} kwargs Additional request parameters
      * @returns {JSON} Data extracted from the document
      */
     public process_business_card_from_stream(
-        file: fs.ReadStream,
+        file: stream.Readable,
         file_name: string,
         {...kwargs}?: VeryfiExtraArgs
     ): Promise<JsonObject>;
@@ -606,7 +607,7 @@ export declare class Client {
      * Process check and extract all the fields from it. https://docs.veryfi.com/api/checks/process-a-check/
      *
      * @memberof Client
-     * @param {fs.ReadStream} file file to submit for data extraction
+     * @param {stream.Readable} 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.
@@ -614,7 +615,7 @@ export declare class Client {
      * @returns {JSON} Data extracted from the document
      */
     public process_check_from_stream(
-        file: fs.ReadStream,
+        file: stream.Readable,
         file_name: string,
         bounding_boxes?: boolean,
         confidence_details?: boolean,
@@ -703,7 +704,7 @@ export declare class Client {
      * Process w2 and extract all the fields from it. https://docs.veryfi.com/api/w2s/process-a-w-2/
      *
      * @memberof Client
-     * @param {fs.ReadStream} file file to submit for data extraction
+     * @param {stream.Readable} file file to submit for data extraction
      * @param {String} file_name The file name including the extension
      * @param {boolean} auto_delete Delete this document from Veryfi after data has been extracted
      * @param {int} max_pages_to_process When sending a long document to Veryfi for processing, this parameter controls how many pages of the document will be read and processed, starting from page 1.
@@ -711,7 +712,7 @@ export declare class Client {
      * @returns {JSON} Data extracted from the document
      */
     public process_w2_from_stream(
-        file: fs.ReadStream,
+        file: stream.Readable,
         file_name: string,
         auto_delete?: boolean,
         max_pages_to_process?: number,
@@ -826,7 +827,7 @@ export declare class Client {
      * Process W-8BEN-E and extract all the fields from it. https://docs.veryfi.com/api/w-8ben-e/process-a-w-8-ben-e/
      *
      * @memberof Client
-     * @param {fs.ReadStream} file file to submit for data extraction
+     * @param {stream.Readable} 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.
@@ -834,7 +835,7 @@ export declare class Client {
      * @returns {JSON} Data extracted from the document
      */
     public process_w8bene_from_stream(
-        file: fs.ReadStream,
+        file: stream.Readable,
         file_name: string,
         bounding_boxes?: boolean,
         confidence_details?: boolean,
@@ -943,7 +944,7 @@ export declare class Client {
      * Process w9 and extract all the fields from it. https://docs.veryfi.com/api/w9s/process-a-w-9/
      *
      * @memberof Client
-     * @param {fs.ReadStream} file file to submit for data extraction
+     * @param {stream.Readable} 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.
@@ -951,7 +952,7 @@ export declare class Client {
      * @returns {JSON} Data extracted from the document
      */
     public process_w9_from_stream(
-        file: fs.ReadStream,
+        file: stream.Readable,
         file_name: string,
         bounding_boxes?: boolean,
         confidence_details?: boolean,

package/lib/types/LineItem.ts

@@ -1,13 +1,23 @@
 import {BoundingElement} from "./BoundingElement";
 
-
 export declare type LineItem = {
+    category?: null | string | BoundingElement;
+    country_of_origin?: null | string | BoundingElement;
+    custom_fields?: Record<string, unknown>;
     date?: null | string | BoundingElement;
     description?: null | string | BoundingElement;
     discount?: null | number | BoundingElement;
+    discount_price?: null | number | BoundingElement;
+    discount_rate?: null | number | BoundingElement;
     end_date?: null | string | BoundingElement;
+    full_description?: null | string | BoundingElement;
+    gross_total?: null | number | BoundingElement;
     hsn?: null | string;
     id?: null | number;
+    lot?: null | string | BoundingElement;
+    manufacturer?: null | string | BoundingElement;
+    net_total?: null | number | BoundingElement;
+    normalized_description?: null | string | BoundingElement;
     order?: null | number;
     price?: null | number | BoundingElement;
     quantity?: null | number | BoundingElement;
@@ -15,10 +25,15 @@ export declare type LineItem = {
     section?: null | string;
     sku?: null | string | BoundingElement;
     start_date?: null | string;
-    tags?: null | null[];
+    subtotal?: null | number | BoundingElement;
+    tags?: null | string[];
     tax?: null | number | BoundingElement;
+    tax_code?: null | string | BoundingElement;
     tax_rate?: null | number;
+    text?: null | string | BoundingElement;
     total?: null | number | BoundingElement;
     type?: null | string;
     unit_of_measure?: null | string;
+    upc?: null | string | BoundingElement;
+    weight?: null | number | BoundingElement;
 };

package/lib/types/Vendor.ts

@@ -1,15 +1,35 @@
 import {BoundingElement} from "./BoundingElement";
 
 export declare type Vendor = {
+    abn_number?: null | string | BoundingElement;
+    account_currency?: null | string | BoundingElement;
+    account_number?: null | string | BoundingElement;
     address?: null | string | BoundingElement;
+    bank_breakdown?: Array<null | Record<string, unknown>>;
+    bank_name?: null | string | BoundingElement;
+    bank_number?: null | string | BoundingElement;
+    bank_swift?: null | string | BoundingElement;
+    biller_code?: null | string | BoundingElement;
     category?: null | string | BoundingElement;
+    country_code?: null | string | BoundingElement;
     email?: null | string | BoundingElement;
+    external_id?: null | string | BoundingElement;
+    external_ids?: Array<null | string>;
     fax_number?: null | string | BoundingElement;
+    iban?: null | string | BoundingElement;
+    lat?: number;
+    lng?: number;
+    logo?: null | string | BoundingElement;
+    logo_name?: null | string | BoundingElement;
+    map_url?: null | string | BoundingElement;
     name?: null | string | BoundingElement;
+    order_number?: null | string | BoundingElement;
+    parsed_address?: null | Record<string, unknown>;
     phone_number?: null | string | BoundingElement;
+    raw_address?: null | string | BoundingElement;
     raw_name?: null | string;
-    vendor_logo?: null | string | BoundingElement;
-    vendor_reg_number?: null | string | BoundingElement;
-    vendor_type?: null | string;
+    reg_number?: null | string | BoundingElement;
+    type?: null | string | BoundingElement;
+    vat_number?: null | string | BoundingElement;
     web?: null | string | BoundingElement;
 };

package/lib/types/VeryfiDocument.ts

@@ -16,7 +16,7 @@ export declare type VeryfiDocument = {
     account_number?: null | string | BoundingElement;
     accounting_entry_type?: null | string;
     balance?: null | string | BoundingElement;
-    barcodes?: null | string[] | BoundingElement[];
+    barcodes?: null | Array<{ data: string; type: string }>;
     bill_to?: null | BillTo;
     card_number?: null | string | BoundingElement;
     cashback?: null | number | BoundingElement;
@@ -51,9 +51,67 @@ export declare type VeryfiDocument = {
     is_document?: null | boolean;
     is_duplicate?: null | boolean;
     is_money_in?: null | boolean | BoundingElement;
+    language?: null | string[];
     license_plate_number?: null | string | BoundingElement;
     line_items?: null | LineItem[];
     line_items_with_scores?: null | LineItem[];
+    meta?: null | {
+        device_id?: null | string;
+        device_user_uuid?: null | string;
+        duplicates?: Array<{
+            id: number;
+            score: number;
+            url: string;
+        }>;
+        fraud?: {
+            attribution?: null | string;
+            color?: string;
+            custom_types?: string[];
+            decision?: string;
+            images?: Array<{
+                is_lcd: boolean;
+                score: number;
+            }>;
+            pages?: Array<{
+                is_lcd: {
+                    score: number;
+                    value: boolean;
+                };
+            }>;
+            score?: number;
+            submissions?: Record<string, unknown>;
+            types?: string[];
+            version?: null | string;
+        };
+        handwritten_fields?: null | string[];
+        language?: null | string[];
+        owner?: null | string;
+        pages?: Array<{
+            height: number;
+            is_blurry: {
+                score: number;
+                value: boolean;
+            };
+            language: string[];
+            screenshot: {
+                score: number;
+                type: null | string;
+            };
+            width: number;
+        }>;
+        processed_pages?: null | number;
+        source?: null | string;
+        source_documents?: Array<{
+            height: number;
+            size_kb: number;
+            width: number;
+        }>;
+        total_pages?: null | number;
+        warnings?: Array<{
+            message: string;
+            type: string;
+        }>;
+    };
     notes?: null | string;
     ocr_text?: null | string;
     order_date?: null | string | BoundingElement;
@@ -61,6 +119,7 @@ export declare type VeryfiDocument = {
     pdf_url?: null | string;
     previous_balance?: null | number | BoundingElement;
     purchase_order_number?: null | string | BoundingElement;
+    reference_number?: null | string | BoundingElement;
     rounding?: null | number | BoundingElement;
     server_name?: null | string | BoundingElement;
     service_end_date?: null | string;
@@ -76,7 +135,6 @@ export declare type VeryfiDocument = {
     tax_lines?: null | TaxLine[];
     tip?: null | number | BoundingElement;
     total?: null | number | BoundingElement;
-    total_pages?: null | number;
     total_quantity?: null | string | BoundingElement;
     total_weight?: null | string | BoundingElement;
     tracking_number?: null | string | BoundingElement;

package/lib/w2s/processW2Stream.js

@@ -2,7 +2,7 @@ const Client = require('../client/constructor');
 /**
  * Upload a w2 document from a buffer. https://docs.veryfi.com/api/w2s/process-a-w-2/
  * @memberOf Client
- * @param {fs.ReadStream} file file to submit for data extraction
+ * @param {stream.Readable} file file to submit for data extraction
  * @param {String} file_name The file name including the extension
  * @param {boolean} auto_delete Delete this document from Veryfi after data has been extracted
  * @param {int} max_pages_to_process When sending a long document to Veryfi for processing, this parameter controls how many pages of the document will be read and processed, starting from page 1.

package/lib/w8bene/processW8BENEStream.js

@@ -3,7 +3,7 @@ const Client = require('../client/constructor');
  * Upload a W-8BEN-E document from a buffer. https://docs.veryfi.com/api/w-8ben-e/process-a-w-8-ben-e/
  *
  * @memberof Client
- * @param {fs.ReadStream} file file to submit for data extraction
+ * @param {stream.Readable} 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.

package/lib/w9s/processW9Stream.js

@@ -2,7 +2,7 @@ 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 {stream.Readable} 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.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@veryfi/veryfi-sdk",
-  "version": "1.4.0",
+  "version": "1.4.2",
   "description": "Node.js module for communicating with the Veryfi OCR API",
   "main": "lib/client/client.js",
   "typings": "lib/types/Client.ts",