@veryfi/veryfi-sdk 1.2.4 → 1.3.0

package/README.md

@@ -38,7 +38,7 @@ You may need to run the above command with `sudo`.
 
 ### Obtaining Client ID and user keys
 
-If you don't have an account with Veryfi, please go ahead and register here: [https://hub.veryfi.com/signup/api/](https://hub.veryfi.com/signup/api/)
+If you don't have an account with Veryfi, please go ahead and register here: [https://app.veryfi.com/signup/api/](https://app.veryfi.com/signup/api/)
 
 ### Node.js API Client Library
 
@@ -248,11 +248,14 @@ veryfi_client.update_document(id=12345,
 ```
 
 ## Need help?
+Visit https://docs.veryfi.com/ to access integration guides and usage notes in the Veryfi API Documentation Portal
 
 If you run into any issue or need help installing or using the library, please contact support@veryfi.com.
 
 If you found a bug in this library or would like new features added, then open an issue or pull requests against this repo!
 
+### [API Docs](https://docs.veryfi.com/)
+
 ### [Learn more at our blog](https://www.veryfi.com/nodejs/)
 
 ## Tutorial Video

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.2.4",
+        "User-Agent": "Node.js Veryfi-Nodejs/1.3.0",
         "Accept": "application/json",
         "Content-Type": "application/json",
         "Client-Id": this.client_id,
@@ -535,6 +535,34 @@ Client.prototype.delete_tags = async function (document_id) {
     return this._request("DELETE", endpoint_name, request_arguments);
 }
 
+/**
+ * Replace multiple tags on an existing document
+ *
+ * @param {number} document_id ID of the document you'd like to add a Tag
+ * @param {string[]} tags array of tags to be added
+ * @return {JSON} response about tag added.
+ */
+Client.prototype.replace_tags = async function (document_id, tags) {
+    let endpoint_name = `/documents/${document_id}/`;
+    let request_arguments = {"tags": tags};
+    let response = await this._request("PUT", endpoint_name, request_arguments);
+    return response['data'];
+}
+
+/**
+ * Add multiple tags on an existing document
+ *
+ * @param {number} document_id ID of the document you'd like to add a Tag
+ * @param {string[]} tags array of tags to be added
+ * @return {JSON} response about tag added.
+ */
+Client.prototype.add_tags = async function (document_id, tags) {
+    let endpoint_name = `/documents/${document_id}/tags/`;
+    let request_arguments = {"tags": tags};
+    let response = await this._request("POST", endpoint_name, request_arguments);
+    return response['data'];
+}
+
 
 // Exports
 

package/lib/types/main.d.ts

@@ -4,124 +4,149 @@ import fs from "fs";
  * Additional request parameters type
  */
 export declare type VeryfiExtraArgs = Record<
-  string | number | symbol,
-  string | number | boolean
+    string | number | symbol,
+    string | number | boolean
 >;
 
+export declare type BoundingElement = {
+  bounding_box?: null | number[];
+  bounding_region?: null | number[];
+  rotation?: null | number;
+  value?: null | number | string;
+}
+
 /**
  * Object of data extracted from the document
  */
 export declare type VeryfiDocument = {
-  abn_number?: null | string;
-  account_number?: null | string;
-  bill_to_address?: null | string;
-  bill_to_name?: null | string;
-  bill_to_vat_number?: null | string;
-  card_number?: null | string;
-  cashback?: null | number;
-  category?: null | string;
-  created?: null | string;
-  currency_code?: null | string;
-  date?: null | string;
-  delivery_date?: null | string;
-  discount?: null | number;
-  document_reference_number?: null | string;
-  document_title?: null | string;
-  document_type?: null | string;
-  due_date?: null | string;
+  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;
-  insurance?: null | number;
-  invoice_number?: null | string;
-  is_duplicate?: null | number;
+  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;
+  order_date?: null | string | BoundingElement;
   payment?: null | Payment;
-  payment_display_name?: null | string;
-  payment_terms?: null | string;
-  payment_type?: null | string;
   pdf_url?: null | string;
-  phone_number?: null | string;
-  purchase_order_number?: null | string;
-  rounding?: null | number;
+  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;
-  ship_to_address?: null | string;
-  ship_to_name?: null | string;
-  shipping?: null | number;
-  store_number?: null | string;
-  subtotal?: null | number;
-  tax?: null | number;
+  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;
-  total?: null | number;
-  total_weight?: null | string;
-  tracking_number?: null | string;
-  updated?: null | string;
+  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;
-  vendor_account_number?: null | string;
-  vendor_bank_name?: null | string;
-  vendor_bank_number?: null | string;
-  vendor_bank_swift?: null | string;
-  vendor_iban?: null | string;
+  vendors?: null | BoundingElement[];
+  vin_number?: null | string | BoundingElement;
+  warnings?: null | string[];
+  weights?: null | BoundingElement[];
 };
 
 declare type LineItem = {
-  date?: null | string;
-  description?: null | string;
-  discount?: null | number;
-  end_date?: null | string;
+  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;
-  quantity?: null | number;
-  reference?: null | string;
+  price?: null | number | BoundingElement;
+  quantity?: null | number | BoundingElement;
+  reference?: null | string | BoundingElement;
   section?: null | string;
-  sku?: null | string;
+  sku?: null | string | BoundingElement;
   start_date?: null | string;
   tags?: null | null[];
-  tax?: null | number;
+  tax?: null | number| BoundingElement;
   tax_rate?: null | number;
-  total?: null | number;
+  total?: null | number | BoundingElement;
   type?: null | string;
   unit_of_measure?: null | string;
 };
 
 declare type TaxLine = {
-  base?: null | number;
-  name?: null | string;
+  base?: null | number | BoundingElement;
+  name?: null | string | BoundingElement;
   order?: null | number;
-  rate?: null | number;
-  total?: null | number;
+  rate?: null | number | BoundingElement;
+  total?: null | number | BoundingElement;
 };
 
 declare type Vendor = {
-  address?: null | string;
-  category?: null | string;
-  email?: null | string;
-  fax_number?: null | string;
-  name?: null | string;
-  phone_number?: null | string;
+  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;
-  vendor_reg_number?: null | string;
+  vendor_logo?: null | string | BoundingElement;
+  vendor_reg_number?: null | string | BoundingElement;
   vendor_type?: null | string;
-  web?: null | string;
+  web?: null | string | BoundingElement;
 };
 
 declare type Payment = {
-  card_number?: null | string;
-  display_name?: null | string;
-  terms?: null | number;
+  card_number?: null | string | BoundingElement;
+  display_name?: null | string | BoundingElement;
+  terms?: null | number | BoundingElement;
   type?: null | string;
 };
 
@@ -130,6 +155,22 @@ declare type Tag = {
   name?: null | string;
 };
 
+declare type BillTo = {
+  address?: null | string | BoundingElement;
+  email?: null | string | BoundingElement;
+  name?: null | string | BoundingElement;
+  parsed_address?: null | string;
+  phone_number?: null | number | string | BoundingElement;
+  reg_number?: null | number | string | BoundingElement;
+  vat_number?: null | number | string | BoundingElement;
+};
+
+declare type ShipTo = {
+  address?: null | string | BoundingElement;
+  name?: null | string | BoundingElement;
+  parsed_address?: null | string;
+};
+
 export declare class Client {
   /**
    * Create instance of a Client
@@ -143,13 +184,13 @@ export declare class Client {
    * @param {number} timeout
    */
   constructor(
-    client_id: string,
-    client_secret: string | undefined,
-    username: string,
-    api_key: string,
-    base_url?: string,
-    api_version?: string,
-    timeout?: number
+      client_id: string,
+      client_secret: string | undefined,
+      username: string,
+      api_key: string,
+      base_url?: string,
+      api_version?: string,
+      timeout?: number
   );
 
   client_id: string;
@@ -256,10 +297,10 @@ export declare class Client {
    * @returns {Promise<VeryfiDocument>} Object of data extracted from the document
    */
   public process_document(
-    file_path: string,
-    categories?: string[],
-    delete_after_processing?: boolean,
-    { ...kwargs }?: VeryfiExtraArgs
+      file_path: string,
+      categories?: string[],
+      delete_after_processing?: boolean,
+      { ...kwargs }?: VeryfiExtraArgs
   ): Promise<VeryfiDocument>;
 
   /**
@@ -276,14 +317,14 @@ export declare class Client {
    * @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,
-    { ...kwargs }?: VeryfiExtraArgs
+      file_url?: string,
+      file_urls?: string[],
+      categories?: string[],
+      delete_after_processing?: boolean,
+      boost_mode?: number,
+      external_id?: string,
+      max_pages_to_process?: number,
+      { ...kwargs }?: VeryfiExtraArgs
   ): Promise<VeryfiDocument>;
 
   /**
@@ -307,8 +348,8 @@ export declare class Client {
    * @return {Promise<VeryfiDocument>} Object of data extracted from the document with updated fields, if fields are writable. Otherwise, a document with unchanged fields.
    */
   public update_document(
-    document_id: string,
-    { ...kwargs }?: VeryfiExtraArgs
+      document_id: string,
+      { ...kwargs }?: VeryfiExtraArgs
   ): Promise<VeryfiDocument>;
 
   /**
@@ -328,6 +369,24 @@ export declare class Client {
    */
   public delete_tags(document_id: string): Promise<any>;
 
+  /**
+   * Add multiple tags on an existing document
+   *
+   * @param {number} document_id ID of the document you'd like to add a Tag
+   * @param {string[]} tags name to add
+   * @return {Promise<Tag>} response about tags added.
+   */
+  public add_tags(document_id: string, tags: string[]): Promise<Tag>;
+
+  /**
+   * Replace multiple tags on an existing document
+   *
+   * @param {number} document_id ID of the document you'd like to add a Tag
+   * @param {string[]} tags names to be added
+   * @return {Promise<Tag>} response about tags added.
+   */
+  public replace_tags(document_id: string, tags: string[]): Promise<Tag>;
+
 }
 
 /**
@@ -342,13 +401,13 @@ export declare class Client {
  * @param {number} timeout
  */
 export declare function Client(
-  client_id: string,
-  client_secret: string | undefined,
-  username: string,
-  api_key: string,
-  base_url?: string,
-  api_version?: string,
-  timeout?: number
+    client_id: string,
+    client_secret: string | undefined,
+    username: string,
+    api_key: string,
+    base_url?: string,
+    api_version?: string,
+    timeout?: number
 ): Client;
 
 export default Client;

package/package.json

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