@veryfi/veryfi-sdk 1.2.1 → 1.2.3

package/README.md

@@ -1,11 +1,12 @@
 # Veryfi SDK for Node.js
 
+<img src="https://user-images.githubusercontent.com/30125790/212157461-58bdc714-2f89-44c2-8e4d-d42bee74854e.png#gh-dark-mode-only" width="200">
+<img src="https://user-images.githubusercontent.com/30125790/212157486-bfd08c5d-9337-4b78-be6f-230dc63838ba.png#gh-light-mode-only" width="200">
+
 [![Node.js - version](https://img.shields.io/badge/node-%3E%3D%206.0.0-brightgreen)](https://www.npmjs.com/package/@veryfi/veryfi-sdk)
 [![npm](https://img.shields.io/badge/npm-v7.0.0-blue)](https://www.npmjs.com/package/@veryfi/veryfi-sdk)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 
-![Veryfi Logo](https://cdn.veryfi.com/logos/veryfi-logo-wide-github.png)
-
 ## Table of Contents
 
 - [Veryfi SDK for Node.js](#veryfi-sdk-for-nodejs)
@@ -62,15 +63,17 @@ This submits a document for processing (3-5 seconds for a response)
 
 ```js
 let veryfi_client = new Client(client_id, client_secret, username, api_key);
-let response = veryfi_client.process_document(file_path, categories=categories);
-console.log(response);
+let response = veryfi_client.process_document(file_path, categories=categories).then(response => {
+  console.log(response)
+});
 ```
 
 ...or with a URL
 
 ```js
-let response = veryfi_client.process_document_url(url, external_id=some_id);
-console.log(response);
+let response = veryfi_client.process_document_url(url, external_id=some_id).then(response => {
+  console.log(response)
+});
 ```
 
 ### Response
@@ -238,7 +241,10 @@ veryfi_client.update_document(id=12345,
         'vendor': new_vendor,
         'category': new_category,
         'total': new_total
-    });
+    })
+.then(response => {
+  console.log(response)
+});
 ```
 
 ## Need help?

package/lib/main.js

@@ -7,7 +7,7 @@ const fs = require('fs');
  * Create instance of a Client
  * @class
  * @param {string} client_id Your Veryfi client id
- * @param {string} client_secret Your Veryfi client secret
+ * @param {string | undefined} client_secret Your Veryfi client secret
  * @param {string} username Your Veryfi username
  * @param {string} api_key Your Veryfi API key
  * @param {string} base_url
@@ -50,7 +50,7 @@ function Client(
 /**
  * Check api version for w2 documents
  * @private
- * @throws if api_version is different to v8
+ * @throws error when api_version is different to v8
  */
 Client.prototype._check_w2_version = function () {
     if (this.api_version !== "v8") throw Error("w2 is only supported on v8")
@@ -64,7 +64,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.0",
+        "User-Agent": "Node.js Veryfi-Nodejs/1.2.3",
         "Accept": "application/json",
         "Content-Type": "application/json",
         "Client-Id": this.client_id,
@@ -211,7 +211,7 @@ Client.prototype.process_document = async function (
     if (!categories) {
         categories = this.CATEGORIES;
     }
-    let file_name = path.basename(file_path)
+    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 = {
@@ -220,8 +220,8 @@ Client.prototype.process_document = async function (
         "categories": categories,
         "auto_delete": delete_after_processing,
     };
-    request_arguments = Object.assign(request_arguments, kwargs)
-    let document = await this._request("POST", endpoint_name, request_arguments)
+    request_arguments = Object.assign(request_arguments, kwargs);
+    let document = await this._request("POST", endpoint_name, request_arguments);
     return document['data'];
 }
 
@@ -260,8 +260,8 @@ Client.prototype.process_document_buffer = async function (
         "categories": categories,
         "auto_delete": delete_after_processing,
     };
-    request_arguments = Object.assign(request_arguments, kwargs)
-    let document = await this._request("POST", endpoint_name, request_arguments)
+    request_arguments = Object.assign(request_arguments, kwargs);
+    let document = await this._request("POST", endpoint_name, request_arguments);
     return document['data'];
 }
 
@@ -275,9 +275,9 @@ Client.prototype.process_document_buffer = async function (
  * @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 {Array} categories List of categories to use when categorizing the document
  * @param {boolean} delete_after_processing 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 {int} boost_mode Flag that tells Veryfi whether boost mode should be enabled. When set to 1, Veryfi will skip data enrichment steps, but will process the document faster. Default value for this flag is 0
  * @param {string} external_id Optional custom document identifier. Use this if you would like to assign your own ID to documents
+ * @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.
  */
@@ -304,7 +304,7 @@ Client.prototype.process_document_url = async function (
         "file_urls": file_urls,
         "max_pages_to_process": max_pages_to_process,
     };
-    request_arguments = Object.assign(request_arguments, kwargs)
+    request_arguments = Object.assign(request_arguments, kwargs);
     let response = await this._request("POST", endpoint_name, request_arguments);
     return response['data'];
 }
@@ -344,15 +344,15 @@ Client.prototype.update_document = async function (document_id, {...kwargs} = {}
  * @return {Array} An array of JSON with all w2 documents.
  */
 Client.prototype.get_w2_documents = async function (page = null) {
-    this._check_w2_version()
-    let endpoint_name = "/w2s/"
-    let request_arguments = {}
-    let params = {}
+    this._check_w2_version();
+    let endpoint_name = "/w2s/";
+    let request_arguments = {};
+    let params = {};
     if (page !== null) {
-        params = {"page": page}
+        params = {"page": page};
     }
-    let response = await this._request("GET", endpoint_name, request_arguments, params)
-    return response['data']['results']
+    let response = await this._request("GET", endpoint_name, request_arguments, params);
+    return response['data']['results'];
 }
 
 /**
@@ -364,11 +364,11 @@ Client.prototype.get_w2_documents = async function (page = null) {
 Client.prototype.get_w2_document = async function (
     document_id,
 ) {
-    this._check_w2_version()
-    let endpoint_name = `/w2s/${document_id}/`
-    let request_arguments = {"id": document_id}
-    let response = await this._request("GET", endpoint_name, request_arguments)
-    return response['data']
+    this._check_w2_version();
+    let endpoint_name = `/w2s/${document_id}/`;
+    let request_arguments = {"id": document_id};
+    let response = await this._request("GET", endpoint_name, request_arguments);
+    return response['data'];
 }
 
 /**
@@ -396,9 +396,9 @@ Client.prototype.process_w2_document_from_buffer = async function (
         "auto_delete": delete_after_processing,
         "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)
-    return response['data']
+    request_arguments = Object.assign(request_arguments, kwargs);
+    let response = await this._request("POST", endpoint_name, request_arguments);
+    return response['data'];
 }
 
 /**
@@ -424,7 +424,7 @@ Client.prototype.process_w2_document = async function (
         delete_after_processing,
         max_pages_to_process,
         kwargs
-    )
+    );
 }
 
 /**
@@ -456,11 +456,38 @@ Client.prototype.process_w2_document_from_url = async function (
         "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)
-    return response['data']
+    request_arguments = Object.assign(request_arguments, kwargs);
+    let response = await this._request("POST", endpoint_name, request_arguments);
+    return response['data'];
+}
+
+/**
+ * Add a new tag on an existing document
+ *
+ * @param {number} document_id ID of the document you'd like to add a Tag
+ * @param {string} tag name to add
+ * @return {JSON} response about tag added.
+ */
+Client.prototype.add_tag = async function (document_id, tag) {
+    let endpoint_name = `/documents/${document_id}/tags/`;
+    let request_arguments = {"name": tag};
+    let response = await this._request("PUT", endpoint_name, request_arguments);
+    return response['data'];
 }
 
+/**
+ * Delete all the tags on an existing document
+ *
+ * @param {number} document_id ID of the document you'd like to delete tags
+ * @return {JSON} response about deleted tags.
+ */
+Client.prototype.delete_tags = async function (document_id) {
+    let endpoint_name = `/documents/${document_id}/tags/`;
+    let request_arguments = {};
+    return this._request("DELETE", endpoint_name, request_arguments);
+}
+
+
 // Exports
 
 module.exports = Client;

package/lib/types/main.d.ts

@@ -122,12 +122,17 @@ declare type Payment = {
   type?: null | string;
 };
 
+declare type Tag = {
+  id?: null | number;
+  name?: null | string;
+};
+
 export declare class Client {
   /**
    * Create instance of a Client
    * @class
    * @param {string} client_id Your Veryfi client id
-   * @param {string} client_secret Your Veryfi client secret
+   * @param {string | undefined} client_secret Your Veryfi client secret
    * @param {string} username Your Veryfi username
    * @param {string} api_key Your Veryfi API key
    * @param {string} base_url
@@ -136,7 +141,7 @@ export declare class Client {
    */
   constructor(
     client_id: string,
-    client_secret: string,
+    client_secret: string | undefined,
     username: string,
     api_key: string,
     base_url?: string,
@@ -146,7 +151,7 @@ export declare class Client {
 
   client_id: string;
 
-  client_secret: string;
+  client_secret: string | undefined;
 
   username: string;
 
@@ -211,20 +216,20 @@ export declare class Client {
    * @param {string[]} 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 {string[]} categories List of categories to use when categorizing the document
    * @param {boolean} delete_after_processing Delete this document from Veryfi after data has been extracted
-   * @param {number} 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 {number} boost_mode Flag that tells Veryfi whether boost mode should be enabled. When set to 1, Veryfi will skip data enrichment steps, but will process the document faster. Default value for this flag is 0
    * @param {string} external_id Optional custom document identifier. Use this if you would like to assign your own ID to documents
+   * @param {number} 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 {VeryfiExtraArgs} kwargs Additional request parameters
    * @return {Promise<VeryfiDocument>} Object of data extracted from the document
    */
   public process_document_url(
     file_url?: string,
+    file_urls?: string[],
     categories?: string[],
     delete_after_processing?: boolean,
     boost_mode?: number,
     external_id?: string,
     max_pages_to_process?: number,
-    file_urls?: string[],
     { ...kwargs }?: VeryfiExtraArgs
   ): Promise<VeryfiDocument>;
 
@@ -234,10 +239,10 @@ export declare class Client {
    * @param {string} document_id ID of the document you'd like to delete
    * @returns {Promise<VeryfiDocument>} Object of data extracted from the document
    */
-  public delete_document(document_id: string): Promise<VeryfiDocument>;
+  public delete_document(document_id: string): Promise<any>;
 
   /**
-   * Update data for a previously processed document, including almost any field like `vendor`, `date`, `notes` and etc.
+   * Update data for a previously processed document, including almost any field like `vendor`, `date`, `notes` etc.
    * @example
    * veryfi_client.update_document(
    *   id,
@@ -252,13 +257,31 @@ export declare class Client {
     document_id: string,
     { ...kwargs }?: VeryfiExtraArgs
   ): Promise<VeryfiDocument>;
+
+  /**
+   * Add a new tag on an existing document
+   *
+   * @param {number} document_id ID of the document you'd like to add a Tag
+   * @param {string} tag name to add
+   * @return {Promise<Tag>} response about tag added.
+   */
+  public add_tag(document_id: string, tag: string): Promise<Tag>;
+
+  /**
+   * Delete all tags on an existing document
+   *
+   * @param {number} document_id ID of the document you'd like to delete all Tags
+   * @return {Promise<any>} response about deleted tags.
+   */
+  public delete_tags(document_id: string): Promise<any>;
+
 }
 
 /**
  * Create instance of a Client
  * @class
  * @param {string} client_id Your Veryfi client id
- * @param {string} client_secret Your Veryfi client secret
+ * @param {string | undefined} client_secret Your Veryfi client secret
  * @param {string} username Your Veryfi username
  * @param {string} api_key Your Veryfi API key
  * @param {string} base_url
@@ -267,7 +290,7 @@ export declare class Client {
  */
 export declare function Client(
   client_id: string,
-  client_secret: string,
+  client_secret: string | undefined,
   username: string,
   api_key: string,
   base_url?: string,

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@veryfi/veryfi-sdk",
-  "version": "1.2.1",
+  "version": "1.2.3",
   "description": "Node.js module for communicating with the Veryfi OCR API",
   "main": "lib/main.js",
-  "typings": "types/main.d.ts",
+  "typings": "lib/types/main.d.ts",
   "scripts": {
     "test": "jest",
     "doc": "jsdoc -d docs --configure jsconf.json main.js",