@veryfi/veryfi-sdk 1.3.1 → 1.3.2

package/lib/main.js

@@ -67,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.3.1",
+        "User-Agent": "Node.js Veryfi-Nodejs/1.3.2",
         "Accept": "application/json",
         "Content-Type": "application/json",
         "Client-Id": this.client_id,
@@ -174,7 +174,13 @@ Client.prototype._request = async function (http_verb, endpoint_name, request_ar
  * @memberof Client
  * @returns {JSON} JSON object of previously processed documents
  */
-Client.prototype.get_documents = async function () {
+Client.prototype.get_documents = async function (
+    page = 1,
+    page_size = 50,
+    bounding_boxes = false,
+    confidence_details = false,
+    {...kwargs} = {}
+) {
     let endpoint_name = "/documents/";
     let request_arguments = {};
     let documents = await this._request("GET", endpoint_name, request_arguments);
@@ -563,6 +569,214 @@ Client.prototype.add_tags = async function (document_id, tags) {
     return response['data'];
 }
 
+/**
+ * Process any document and extract all the fields from it
+ * @example
+ * veryfi_client.process_any_document('file/path','blue_print')
+ *
+ * @memberof Client
+ * @param {String} file_path Path on disk to a file to submit for data extraction
+ * @param {String} template_name name of the extraction templates.
+ * @param {number} max_pages_to_process The number of pages to process for the document. The limit is 50 pages per document.
+ * @param {Object} kwargs Additional request parameters
+ * @returns {JSON} Data extracted from the document
+ */
+Client.prototype.process_any_document = async function (
+    file_path,
+    template_name,
+    max_pages_to_process = 20,
+    {...kwargs} = {}
+) {
+
+    let endpoint_name = "/any-documents/";
+    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 = {
+        "file_name": file_name,
+        "file_data": base64_encoded_string,
+        "template_name": template_name,
+        "max_pages_to_process": max_pages_to_process,
+    };
+    request_arguments = Object.assign(request_arguments, kwargs);
+    let document = await this._request("POST", endpoint_name, request_arguments);
+    return document['data'];
+}
+
+/**
+ * Process any document and extract all the fields from it
+ * @example
+ * veryfi_client.process_any_document_url('file_url','blue_print')
+ *
+ * @memberof Client
+ * @param {String} file_url url file to submit for data extraction
+ * @param {String} template_name name of the extraction templates.
+ * @param {number} max_pages_to_process The number of pages to process for the document. The limit is 50 pages per document.
+ * @param {Object} kwargs Additional request parameters
+ * @returns {JSON} Data extracted from the document
+ */
+Client.prototype.process_any_document_url = async function (
+    file_url,
+    template_name,
+    max_pages_to_process = 20,
+    {...kwargs} = {}
+) {
+
+    let endpoint_name = "/any-documents/";
+    let request_arguments = {
+        "file_url": file_url,
+        "template_name": template_name,
+        "max_pages_to_process": max_pages_to_process,
+    };
+    request_arguments = Object.assign(request_arguments, kwargs);
+    let document = await this._request("POST", endpoint_name, request_arguments);
+    return document['data'];
+}
+
+/**
+ * Get all any documents
+ * @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.
+ * @returns {JSON} Object of previously processed any documents
+ */
+Client.prototype.get_any_documents = async function (
+    page = 1,
+    page_size = 50) {
+    let endpoint_name = "/any-documents/";
+    let request_arguments = {"page": page, "page_size": page_size};
+    let documents = await this._request("GET", endpoint_name, request_arguments);
+    if ("data" in documents) {
+        documents = documents["data"];
+    }
+    return documents;
+}
+
+/**
+ * Get a specific any document
+ * @memberof Client
+ * @param {number} document_id The unique identifier of the document.
+ * @returns {JSON} Object of a previously processed blueprinted document.
+ */
+Client.prototype.get_any_document = async function (document_id) {
+    let endpoint_name = `/any-documents/${document_id}/`;
+    let request_arguments = {};
+    let document = await this._request("GET", endpoint_name, request_arguments);
+    return document['data'];
+}
+
+/**
+ * Get a specific bank statement
+ * @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.
+ * @returns {JSON} Object of a previously processed blueprinted document.
+ */
+Client.prototype.get_bank_statement = async function (
+    document_id,
+    bounding_boxes = false,
+    confidence_details = false
+) {
+    let endpoint_name = `/bank-statements/${document_id}/`;
+    let request_arguments = {
+        "bounding_boxes": bounding_boxes,
+        "confidence_details": confidence_details
+    };
+    let document = await this._request("GET", endpoint_name, request_arguments);
+    return document['data'];
+}
+
+/**
+ * Get all bank statements
+ * @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.
+ * @returns {JSON} Object of previously processed any documents
+ */
+Client.prototype.get_bank_statements = async function (
+    page = 1,
+    page_size = 50,
+    bounding_boxes = false,
+    confidence_details = false
+) {
+    let endpoint_name = `/bank-statements/`;
+    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);
+    return document['data'];
+}
+
+/**
+ * Process bank statement and extract all the fields from it
+ * @example
+ * veryfi_client.process_bank_statement('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_bank_statement = async function (
+    file_path,
+    bounding_boxes = false,
+    confidence_details = false,
+    {...kwargs} = {}
+) {
+
+    let endpoint_name = "/bank-statements/";
+    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 = {
+        "file_name": file_name,
+        "file_data": base64_encoded_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'];
+}
+
+/**
+ * Process bank statement and extract all the fields from it
+ * @example
+ * veryfi_client.process_bank_statement_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_bank_statement_url = async function (
+    file_url,
+    bounding_boxes = false,
+    confidence_details = false,
+    {...kwargs} = {}
+) {
+
+    let endpoint_name = "/bank-statements/";
+    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);
+    return document['data'];
+}
+
 
 // Exports
 

package/lib/types/main.d.ts

@@ -1,4 +1,5 @@
 import fs from "fs";
+import path from "path";
 
 /**
  * Additional request parameters type
@@ -15,6 +16,8 @@ export declare type BoundingElement = {
   value?: null | number | string;
 }
 
+export type JsonObject = Record<string, any>;
+
 /**
  * Object of data extracted from the document
  */
@@ -114,7 +117,7 @@ declare type LineItem = {
   sku?: null | string | BoundingElement;
   start_date?: null | string;
   tags?: null | null[];
-  tax?: null | number| BoundingElement;
+  tax?: null | number | BoundingElement;
   tax_rate?: null | number;
   total?: null | number | BoundingElement;
   type?: null | string;
@@ -220,7 +223,12 @@ export declare class Client {
    * @memberof Client
    * @returns {Promise<VeryfiDocument>} Object of previously processed documents
    */
-  public get_documents(): Promise<VeryfiDocument[]>;
+  public get_documents(
+      page?: number,
+      page_size?: number,
+      bounding_boxes?: boolean,
+      confidence_details?: boolean
+  ): Promise<VeryfiDocument[]>;
 
   /**
    * Retrieve document by ID
@@ -252,7 +260,7 @@ export declare class Client {
       file_name: string,
       categories?: string[],
       delete_after_processing?: boolean,
-      { ...kwargs }?: VeryfiExtraArgs
+      {...kwargs}?: VeryfiExtraArgs
   ): Promise<VeryfiDocument>;
 
   /**
@@ -277,7 +285,7 @@ export declare class Client {
       file_name: string,
       categories?: string[],
       delete_after_processing?: boolean,
-      { ...kwargs }?: VeryfiExtraArgs
+      {...kwargs}?: VeryfiExtraArgs
   ): Promise<VeryfiDocument>;
 
   /**
@@ -300,7 +308,7 @@ export declare class Client {
       file_path: string,
       categories?: string[],
       delete_after_processing?: boolean,
-      { ...kwargs }?: VeryfiExtraArgs
+      {...kwargs}?: VeryfiExtraArgs
   ): Promise<VeryfiDocument>;
 
   /**
@@ -324,7 +332,7 @@ export declare class Client {
       boost_mode?: number,
       external_id?: string,
       max_pages_to_process?: number,
-      { ...kwargs }?: VeryfiExtraArgs
+      {...kwargs}?: VeryfiExtraArgs
   ): Promise<VeryfiDocument>;
 
   /**
@@ -349,7 +357,7 @@ export declare class Client {
    */
   public update_document(
       document_id: string,
-      { ...kwargs }?: VeryfiExtraArgs
+      {...kwargs}?: VeryfiExtraArgs
   ): Promise<VeryfiDocument>;
 
   /**
@@ -387,6 +395,126 @@ export declare class Client {
    */
   public replace_tags(document_id: string, tags: string[]): Promise<Tag>;
 
+  /**
+   * Process any document and extract all the fields from it
+   * @example
+   * veryfi_client.process_any_document('file/path','template_name')
+   *
+   * @memberof Client
+   * @param {String} file_path Path on disk to a file to submit for data extraction
+   * @param {String} template_name name of the extraction templates.
+   * @param {number} max_pages_to_process The number of pages to process for the document. The limit is 50 pages per document.
+   * @param {Object} kwargs Additional request parameters
+   * @returns {JSON} Data extracted from the document
+   */
+  public process_any_document(
+      file_path: string,
+      template_name?: string,
+      max_pages_to_process?: number,
+      {...kwargs}?: VeryfiExtraArgs
+  ): Promise<JsonObject>;
+
+  /**
+   * Process any document and extract all the fields from it
+   * @example
+   * veryfi_client.process_any_document_url('file_url','template_name')
+   *
+   * @memberof Client
+   * @param {String} file_url url file to submit for data extraction
+   * @param {String} template_name name of the extraction templates.
+   * @param {number} max_pages_to_process The number of pages to process for the document. The limit is 50 pages per document.
+   * @param {Object} kwargs Additional request parameters
+   * @returns {JSON} Data extracted from the document
+   */
+  public process_any_document_url(
+      file_url: string,
+      template_name?: string,
+      max_pages_to_process?: number,
+      {...kwargs}?: VeryfiExtraArgs
+  ): Promise<JsonObject>;
+
+  /**
+   * Get all any documents
+   * @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.
+   * @returns {Promise<JsonObject>} Object of previously processed any documents
+   */
+  public get_any_documents(page?: number, page_size?: number): Promise<JsonObject[]>;
+
+  /**
+   * Get a specific any document
+   * @memberof Client
+   * @param {number} document_id The unique identifier of the document.
+   * @returns {Promise<JsonObject>} Object of a previously processed blueprinted document.
+   */
+  public get_any_document(document_id: number): Promise<JsonObject[]>;
+
+  /**
+   * Get a specific bank statement
+   * @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.
+   * @returns {Promise<JsonObject>} Object of a previously processed blueprinted document.
+   */
+  public get_bank_statement(document_id: number, bounding_boxes?: boolean,
+                            confidence_details?: boolean): Promise<JsonObject[]>;
+
+  /**
+   * Get all bank statements
+   * @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.
+   * @returns {Promise<JsonObject>} Object of previously processed any documents
+   */
+  public get_bank_statements(
+      page?: number,
+      page_size?: number,
+      bounding_boxes?: boolean,
+      confidence_details?: boolean
+  ): Promise<JsonObject[]>;
+
+  /**
+   * Process bank statement and extract all the fields from it
+   * @example
+   * veryfi_client.process_bank_statement('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
+   */
+  public process_bank_statement(
+      file_path: string,
+      bounding_boxes?: boolean,
+      confidence_details?: boolean,
+      {...kwargs}?: VeryfiExtraArgs
+  ): Promise<JsonObject>;
+
+  /**
+   * Process any document and extract all the fields from it
+   * @example
+   * veryfi_client.process_bank_statement_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
+   */
+  public process_bank_statement_url(
+      file_url: string,
+      bounding_boxes?: boolean,
+      confidence_details?: boolean,
+      {...kwargs}?: VeryfiExtraArgs
+  ): Promise<JsonObject>;
+
 }
 
 /**

package/package.json

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