@veryfi/veryfi-sdk 1.3.1 → 1.4.0

package/lib/types/LineItem.ts

@@ -0,0 +1,24 @@
+import {BoundingElement} from "./BoundingElement";
+
+
+export declare type LineItem = {
+    date?: null | string | BoundingElement;
+    description?: null | string | BoundingElement;
+    discount?: null | number | BoundingElement;
+    end_date?: null | string | BoundingElement;
+    hsn?: null | string;
+    id?: null | number;
+    order?: null | number;
+    price?: null | number | BoundingElement;
+    quantity?: null | number | BoundingElement;
+    reference?: null | string | BoundingElement;
+    section?: null | string;
+    sku?: null | string | BoundingElement;
+    start_date?: null | string;
+    tags?: null | null[];
+    tax?: null | number | BoundingElement;
+    tax_rate?: null | number;
+    total?: null | number | BoundingElement;
+    type?: null | string;
+    unit_of_measure?: null | string;
+};

package/lib/types/Payment.ts

@@ -0,0 +1,8 @@
+import {BoundingElement} from "./BoundingElement";
+
+export declare type Payment = {
+    card_number?: null | string | BoundingElement;
+    display_name?: null | string | BoundingElement;
+    terms?: null | number | BoundingElement;
+    type?: null | string;
+};

package/lib/types/ShipTo.ts

@@ -0,0 +1,7 @@
+import {BoundingElement} from "./BoundingElement";
+
+export declare type ShipTo = {
+    address?: null | string | BoundingElement;
+    name?: null | string | BoundingElement;
+    parsed_address?: null | string;
+};

package/lib/types/Tag.ts

@@ -0,0 +1,4 @@
+export declare type Tag = {
+    id?: null | number;
+    name?: null | string;
+};

package/lib/types/TaxLine.ts

@@ -0,0 +1,9 @@
+import {BoundingElement} from "./BoundingElement";
+
+export declare type TaxLine = {
+    base?: null | number | BoundingElement;
+    name?: null | string | BoundingElement;
+    order?: null | number;
+    rate?: null | number | BoundingElement;
+    total?: null | number | BoundingElement;
+};

package/lib/types/Vendor.ts

@@ -0,0 +1,15 @@
+import {BoundingElement} from "./BoundingElement";
+
+export declare type Vendor = {
+    address?: null | string | BoundingElement;
+    category?: null | string | BoundingElement;
+    email?: null | string | BoundingElement;
+    fax_number?: null | string | BoundingElement;
+    name?: null | string | BoundingElement;
+    phone_number?: null | string | BoundingElement;
+    raw_name?: null | string;
+    vendor_logo?: null | string | BoundingElement;
+    vendor_reg_number?: null | string | BoundingElement;
+    vendor_type?: null | string;
+    web?: null | string | BoundingElement;
+};

package/lib/types/VeryfiDocument.ts

@@ -0,0 +1,93 @@
+import {BoundingElement} from "./BoundingElement";
+import {BillTo} from "./BillTo";
+import {VeryfiExtraArgs} from "./VeryfiExtraArgs";
+import {LineItem} from "./LineItem";
+import {Payment} from "./Payment";
+import {ShipTo} from "./ShipTo";
+import {Tag} from "./Tag";
+import {TaxLine} from "./TaxLine";
+import {Vendor} from "./Vendor";
+
+/**
+* Object of data extracted from the document
+*/
+export declare type VeryfiDocument = {
+    abn_number?: null | string | BoundingElement;
+    account_number?: null | string | BoundingElement;
+    accounting_entry_type?: null | string;
+    balance?: null | string | BoundingElement;
+    barcodes?: null | string[] | BoundingElement[];
+    bill_to?: null | BillTo;
+    card_number?: null | string | BoundingElement;
+    cashback?: null | number | BoundingElement;
+    category?: null | string | BoundingElement;
+    created_date?: null | string;
+    currency_code?: null | string | BoundingElement;
+    custom_fields?: null | VeryfiExtraArgs;
+    date?: null | string | BoundingElement;
+    default_category?: null | string | BoundingElement;
+    delivery_date?: null | string | BoundingElement;
+    delivery_note_number?: null | string | BoundingElement;
+    discount?: null | number | BoundingElement;
+    document_reference_number?: null | string | BoundingElement;
+    document_title?: null | string | BoundingElement;
+    document_type?: null | string | BoundingElement;
+    due_date?: null | string | BoundingElement;
+    duplicate_of?: null | number;
+    exch_rate?: null | number;
+    external_id?: null | string;
+    final_balance?: null | number | BoundingElement;
+    guest_count?: null | number | BoundingElement;
+    id?: null | number;
+    img_blur?: null | boolean;
+    img_file_name?: null | string;
+    img_thumbnail_url?: null | string;
+    img_url?: null | string;
+    incoterms?: null | number | BoundingElement;
+    insurance?: null | number | BoundingElement;
+    invoice_number?: null | string | BoundingElement;
+    is_approved?: null | boolean;
+    is_blurry?: null | boolean[];
+    is_document?: null | boolean;
+    is_duplicate?: null | boolean;
+    is_money_in?: null | boolean | BoundingElement;
+    license_plate_number?: null | string | BoundingElement;
+    line_items?: null | LineItem[];
+    line_items_with_scores?: null | LineItem[];
+    notes?: null | string;
+    ocr_text?: null | string;
+    order_date?: null | string | BoundingElement;
+    payment?: null | Payment;
+    pdf_url?: null | string;
+    previous_balance?: null | number | BoundingElement;
+    purchase_order_number?: null | string | BoundingElement;
+    rounding?: null | number | BoundingElement;
+    server_name?: null | string | BoundingElement;
+    service_end_date?: null | string;
+    service_start_date?: null | string;
+    ship_date?: null | string | BoundingElement;
+    ship_to?: null | ShipTo;
+    shipping?: null | number | BoundingElement;
+    status?: null | string;
+    store_number?: null | string | BoundingElement;
+    subtotal?: null | number | BoundingElement;
+    tags?: null | Tag[];
+    tax?: null | number | BoundingElement;
+    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;
+    tracking_numbers?: null | BoundingElement[];
+    updated_date?: null | string;
+    vending_person?: null | string | BoundingElement;
+    vending_person_number?: null | string | BoundingElement;
+    vat_number?: null | string;
+    vendor?: null | Vendor;
+    vendors?: null | BoundingElement[];
+    vin_number?: null | string | BoundingElement;
+    warnings?: null | string[];
+    weights?: null | BoundingElement[];
+};

package/lib/types/VeryfiExtraArgs.ts

@@ -0,0 +1,9 @@
+/**
+ * Additional request parameters type
+ */
+export declare type VeryfiExtraArgs = Record<
+    string | number | symbol,
+    string | number | boolean
+>;
+
+export type JsonObject = Record<string, any>;

package/lib/w2s/deleteW2.js

@@ -0,0 +1,12 @@
+const Client = require('../client/constructor');
+/**
+ * Delete w2 document from Veryfi https://docs.veryfi.com/api/w2s/delete-a-w-2/
+ *
+ * @memberof Client
+ * @param {string} document_id ID of the document you'd like to delete
+ */
+Client.prototype.delete_w2 = async function (document_id) {
+    let endpoint_name = `/w2s/${document_id}/`;
+    let request_arguments = {"id": document_id};
+    return this._request("DELETE", endpoint_name, request_arguments);
+}

package/lib/w2s/getW2.js

@@ -0,0 +1,17 @@
+const Client = require('../client/constructor');
+/**
+ * Get a w2 document https://docs.veryfi.com/api/w2s/get-a-w-2/
+ * @memberOf Client
+ * @param {string} document_id ID of the document you'd like to retrieve
+ * @param {Object} kwargs Additional request parameters
+ * @returns {JSON} Data extracted from the Document
+ */
+Client.prototype.get_w2 = async function (
+    document_id,
+    {...kwargs} = {}
+) {
+    let endpoint_name = `/w2s/${document_id}/`;
+    let request_arguments = {"id": document_id};
+    let response = await this._request("GET", endpoint_name, request_arguments, kwargs, false);
+    return response['data'];
+}

package/lib/w2s/getW2s.js

@@ -0,0 +1,13 @@
+const Client = require('../client/constructor');
+/**
+ * Get all w2 documents. https://docs.veryfi.com/api/w2s/get-w-2-s/
+ * @memberOf Client
+ * @param {Object} kwargs Additional request parameters
+ * @return {Array} An array of JSON with all w2 documents.
+ */
+Client.prototype.get_w2s = async function ( {...kwargs} = {}) {
+    let endpoint_name = "/w2s/";
+    let request_arguments = {};
+    let response = await this._request("GET", endpoint_name, request_arguments, kwargs, false);
+    return response['data'];
+}

package/lib/w2s/processW2.js

@@ -0,0 +1,28 @@
+const Client = require('../client/constructor');
+const path = require('path');
+const fs = require('fs');
+/**
+ * Upload a document from a file path https://docs.veryfi.com/api/w2s/process-a-w-2/
+ * @param {String} file_path Path on disk to a file to submit for data extraction
+ * @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.
+ * @param {Object} kwargs Additional request parameters
+ * @return {JSON} Data extracted from the document.
+ */
+Client.prototype.process_w2 = async function (
+    file_path,
+    auto_delete = false,
+    max_pages_to_process = 1,
+    {...kwargs} = {}
+) {
+    let file = fs.createReadStream(file_path);
+    let file_name = path.basename(file_path);
+
+    return this.process_w2_from_stream(
+        file,
+        file_name,
+        auto_delete,
+        max_pages_to_process,
+        kwargs
+    );
+}

package/lib/w2s/processW2Base64.js

@@ -0,0 +1,30 @@
+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 {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} 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.
+ * @param {Object} kwargs Additional request parameters
+ * @return {JSON} Data extracted from the document.
+ */
+Client.prototype.process_w2_from_base64 = async function (
+    file_name,
+    file_base64_string,
+    auto_delete = null,
+    max_pages_to_process = null,
+    {...kwargs} = {}
+) {
+
+    let endpoint_name = "/w2s/"
+    let request_arguments = {
+        "file_name": file_name,
+        "file_data": file_base64_string,
+        "auto_delete": auto_delete,
+        "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, null, false);
+    return response['data'];
+}

package/lib/w2s/processW2Stream.js

@@ -0,0 +1,30 @@
+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 {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.
+ * @param {Object} kwargs Additional request parameters
+ * @return {JSON} Data extracted from the document.
+ */
+Client.prototype.process_w2_from_stream = async function (
+    file,
+    file_name,
+    auto_delete = null,
+    max_pages_to_process = null,
+    {...kwargs} = {}
+) {
+
+    let endpoint_name = "/w2s/"
+    let request_arguments = {
+        "file": file,
+        "file_name": file_name,
+        "auto_delete": auto_delete,
+        "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, null, true);
+    return response['data'];
+}

package/lib/w2s/processW2Url.js

@@ -0,0 +1,32 @@
+const Client = require('../client/constructor');
+/**
+ * Process a w2 document from an url. https://docs.veryfi.com/api/w2s/process-a-w-2/
+ * @memberOf Client
+ * @param {String} file_name The file name including the extension
+ * @param {string} file_url Required if file_urls isn't specified. Publicly accessible URL to a file, e.g. "https://cdn.example.com/receipt.jpg".
+ * @param {Array} file_urls Required if file_url isn't specified. List of publicly accessible URLs to multiple files, e.g. ["https://cdn.example.com/receipt1.jpg", "https://cdn.example.com/receipt2.jpg"]
+ * @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.
+ * @param {Object} kwargs Additional request parameters
+ * @return {JSON} Data extracted from the document.
+ */
+Client.prototype.process_w2_from_url = async function (
+    file_name,
+    file_url,
+    file_urls = null,
+    auto_delete = false,
+    max_pages_to_process = 1,
+    {...kwargs} = {}
+) {
+    let endpoint_name = "/w2s/"
+    let request_arguments = {
+        "file_name": file_name,
+        "auto_delete": auto_delete,
+        "file_url": file_url,
+        "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, null, false);
+    return response['data'];
+}

package/lib/w8bene/deleteW8BENE.js

@@ -0,0 +1,12 @@
+const Client = require('../client/constructor');
+/**
+ * Delete a W-8BEN-E from Veryfi. https://docs.veryfi.com/api/w-8ben-e/delete-a-w-8-ben-e/
+ *
+ * @memberof Client
+ * @param {string} document_id ID of the document you'd like to delete
+ */
+Client.prototype.delete_w8bene = async function (document_id) {
+    let endpoint_name = `/w-8ben-e/${document_id}/`;
+    let request_arguments = {"id": document_id};
+    return this._request("DELETE", endpoint_name, request_arguments);
+}

package/lib/w8bene/getW8BENE.js

@@ -0,0 +1,24 @@
+const Client = require('../client/constructor');
+/**
+ * Get a specific W-8BEN-E. https://docs.veryfi.com/api/w-8ben-e/get-a-w-8-ben-e/
+ * @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_w8bene = async function (
+    document_id,
+    bounding_boxes = false,
+    confidence_details = false,
+    {...kwargs} = {}
+) {
+    let endpoint_name = `/w-8ben-e/${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/w8bene/getW8BENEs.js

@@ -0,0 +1,28 @@
+const Client = require('../client/constructor');
+/**
+ * Get all W-8BEN-E. https://docs.veryfi.com/api/w-8ben-e/get-w-8-ben-es/
+ * @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_w8benes = async function (
+    page = 1,
+    page_size = 50,
+    bounding_boxes = false,
+    confidence_details = false,
+    {...kwargs} = {}
+) {
+    let endpoint_name = `/w-8ben-e/`;
+    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/w8bene/processW8BENE.js

@@ -0,0 +1,33 @@
+const Client = require('../client/constructor');
+const path = require('path');
+const fs = require('fs');
+/**
+ * Process a W-8BEN-E document. https://docs.veryfi.com/api/w-8ben-e/process-a-w-8-ben-e/
+ * @example
+ * veryfi_client.process_w8bene('file_path')
+ *
+ * @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_w8bene = 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_w8bene_from_stream(
+        file,
+        file_name,
+        bounding_boxes,
+        confidence_details,
+        kwargs
+    );
+}

package/lib/w8bene/processW8BENEBase64.js

@@ -0,0 +1,31 @@
+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 {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_w8bene_from_base64 = async function (
+    file_name,
+    file_base64_string,
+    bounding_boxes = false,
+    confidence_details = false,
+    {...kwargs} = {}
+) {
+
+    let endpoint_name = "/w-8ben-e/";
+    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, null, false);
+    return document['data'];
+}

package/lib/w8bene/processW8BENEStream.js

@@ -0,0 +1,31 @@
+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 {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_w8bene_from_stream = async function (
+    file,
+    file_name,
+    bounding_boxes = false,
+    confidence_details = false,
+    {...kwargs} = {}
+) {
+
+    let endpoint_name = "/w-8ben-e/";
+    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/w8bene/processW8BENEUrl.js

@@ -0,0 +1,30 @@
+const Client = require('../client/constructor');
+/**
+ * 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/
+ * @example
+ * veryfi_client.process_w8bene_from_url('file_url')
+ *
+ * @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_w8bene_from_url = async function (
+    file_url,
+    bounding_boxes = false,
+    confidence_details = false,
+    {...kwargs} = {}
+) {
+
+    let endpoint_name = "/w-8ben-e/";
+    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/lib/w9s/deleteW9.js

@@ -0,0 +1,12 @@
+const Client = require('../client/constructor');
+/**
+ * Delete w9 document from Veryfi. https://docs.veryfi.com/api/w9s/delete-a-w-9/
+ *
+ * @memberof Client
+ * @param {string} document_id ID of the document you'd like to delete
+ */
+Client.prototype.delete_w9 = async function (document_id) {
+    let endpoint_name = `/w9s/${document_id}/`;
+    let request_arguments = {"id": document_id};
+    return this._request("DELETE", endpoint_name, request_arguments);
+}

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
+    );
+}