@veryfi/veryfi-sdk 1.1.1 → 1.1.4

package/test/updateDocument.json

@@ -0,0 +1,255 @@
+{
+  "abn_number":"",
+  "account_number":"",
+  "barcodes":[
+
+  ],
+  "bill_to_address":"",
+  "bill_to_name":"",
+  "card_number":"",
+  "category":"Meals",
+  "created":"2021-07-12 01:00:59",
+  "currency_code":"COP",
+  "date":"2020-01-07 11:19:53",
+  "delivery_date":"",
+  "discount":0.0,
+  "document_title":"",
+  "document_type":"receipt",
+  "due_date":"",
+  "external_id":"",
+  "id":37769250,
+  "img_file_name":"c5d8edc4-189b-4da7-b702-1eb65ab8cb3f.jpg",
+  "img_thumbnail_url":"https://scdn.veryfi.com/receipts/c5d8edc4-189b-4da7-b702-1eb65ab8cb3f_t.jpg?Expires=1626052560&Signature=b4n3sN0fyVaYHAY3BUXAyvOSWUcgmcDoqQHsahUu8gnLzR1tek1CERIYF7VeOmxS1kFyCf92HPVotyyS3pU1quhuVnXcExQfMykDq1fgMWxCIWnZYMqglQKp3Ut0OfNUSGlwjjVeovWwTotuN1lr~mMjMJoykaOMxN~v9DM8sXD9qO231YON7tCfkR-RSg362zCa~iJSeSSRGYHmFizhxvNza0LvfB1kVPdQRFssByo3C1hiaZ9oOkfg199Z0McZoDruaY0zhfhoOMl1A08J4Q4WSH90NEu-xuGVn0SdYNIZvdueoR~~fon4PED2kIB5I8yCKJFUPks5J3T3oy7rYQ__&Key-Pair-Id=APKAJCILBXEJFZF4DCHQ",
+  "img_url":"https://scdn.veryfi.com/receipts/c5d8edc4-189b-4da7-b702-1eb65ab8cb3f.jpg?Expires=1626052560&Signature=Ozt1qulJtk3TInOrWk~F-d8-hCx9PU7g780T96MnnR1ufZ9qcy7BotklwinSzcEW-RhcJ46v7HNZhh1upAzFMr0DNfjR3JjNCLcuVfSGmMs6z91S5voMDEJa4Ls2AlE9VmUNs1NzNe8lpRYIxSXADote0rsKXCV5GzGDPc17C-qoGm3uQFCfW7FHN-Rs6zsQAH2rcmxbxRv5dOseVlgDINDTt1~zv-ZJdZ8Yl7wn8MQPBNp4txZJ7l1eYiPk35rSMvKZ1LeixxioXyCJaNv7rmG9y5N2j1ZNGvmqH9gIBMwlcFm-bJcFLvpV5zU2UpDdBIVJ2ILwMkI~auEBxC4qnQ__&Key-Pair-Id=APKAJCILBXEJFZF4DCHQ",
+  "incoterms":"",
+  "insurance":"",
+  "invoice_number":"206136",
+  "is_document":1,
+  "is_money_in":0,
+  "line_items":[
+    {
+      "date":"",
+      "description":"DETERGENTE FAB\nG",
+      "discount":0.0,
+      "id":70455283,
+      "order":0,
+      "price":0.0,
+      "quantity":1.0,
+      "reference":"",
+      "section":"",
+      "sku":"004967",
+      "tax":0.0,
+      "tax_rate":0.0,
+      "total":6200.0,
+      "type":"product",
+      "unit_of_measure":"",
+      "weight":""
+    },
+    {
+      "date":"",
+      "description":"FILETE PECHUGA",
+      "discount":0.0,
+      "id":70455284,
+      "order":1,
+      "price":0.0,
+      "quantity":1.0,
+      "reference":"",
+      "section":"",
+      "sku":"004573",
+      "tax":0.0,
+      "tax_rate":0.0,
+      "total":19900.0,
+      "type":"food",
+      "unit_of_measure":"",
+      "weight":""
+    },
+    {
+      "date":"",
+      "description":"BROCOLI KILO",
+      "discount":0.0,
+      "id":70455285,
+      "order":2,
+      "price":48.0,
+      "quantity":1.0,
+      "reference":"",
+      "section":"",
+      "sku":"005015",
+      "tax":0.0,
+      "tax_rate":0.0,
+      "total":2328.0,
+      "type":"food",
+      "unit_of_measure":"",
+      "weight":""
+    },
+    {
+      "date":"",
+      "description":"CEBOLLA DE HUEVO",
+      "discount":0.0,
+      "id":70455286,
+      "order":3,
+      "price":0.0,
+      "quantity":1.0,
+      "reference":"",
+      "section":"",
+      "sku":"005021",
+      "tax":0.0,
+      "tax_rate":0.0,
+      "total":880.0,
+      "type":"food",
+      "unit_of_measure":"",
+      "weight":""
+    },
+    {
+      "date":"",
+      "description":"ZANAHORIA KILO",
+      "discount":0.0,
+      "id":70455287,
+      "order":4,
+      "price":0.0,
+      "quantity":1.0,
+      "reference":"",
+      "section":"",
+      "sku":"005107",
+      "tax":0.0,
+      "tax_rate":0.0,
+      "total":1320.0,
+      "type":"food",
+      "unit_of_measure":"",
+      "weight":""
+    },
+    {
+      "date":"",
+      "description":"PAPA CAPIRA X",
+      "discount":0.0,
+      "id":70455288,
+      "order":5,
+      "price":0.0,
+      "quantity":1.0,
+      "reference":"",
+      "section":"",
+      "sku":"004736",
+      "tax":0.0,
+      "tax_rate":0.0,
+      "total":1935.0,
+      "type":"food",
+      "unit_of_measure":"",
+      "weight":""
+    },
+    {
+      "date":"",
+      "description":"BOLSA DE",
+      "discount":0.0,
+      "id":70455289,
+      "order":6,
+      "price":0.0,
+      "quantity":1.0,
+      "reference":"",
+      "section":"",
+      "sku":"005157",
+      "tax":0.0,
+      "tax_rate":0.0,
+      "total":500.0,
+      "type":"product",
+      "unit_of_measure":"",
+      "weight":""
+    },
+    {
+      "date":"",
+      "description":"BOLSAS/EMPAQUES",
+      "discount":0.0,
+      "id":70455290,
+      "order":7,
+      "price":0.0,
+      "quantity":1.0,
+      "reference":"",
+      "section":"",
+      "sku":"008777",
+      "tax":0.0,
+      "tax_rate":0.0,
+      "total":50.0,
+      "type":"product",
+      "unit_of_measure":"",
+      "weight":""
+    },
+    {
+      "date":"",
+      "description":"INC Bolsa",
+      "discount":0.0,
+      "id":70455292,
+      "order":8,
+      "price":0.0,
+      "quantity":1.0,
+      "reference":"",
+      "section":"",
+      "sku":"",
+      "tax":0.0,
+      "tax_rate":0.0,
+      "total":50.0,
+      "type":"product",
+      "unit_of_measure":"",
+      "weight":""
+    },
+    {
+      "date":"",
+      "description":"Bolsa Pilstica",
+      "discount":0.0,
+      "id":70455293,
+      "order":9,
+      "price":0.0,
+      "quantity":1.0,
+      "reference":"",
+      "section":"",
+      "sku":"",
+      "tax":0.0,
+      "tax_rate":0.0,
+      "total":0.0,
+      "type":"product",
+      "unit_of_measure":"",
+      "weight":""
+    }
+  ],
+  "notes":"Note updated",
+  "ocr_text":"SUPERMERCADOS MERKAHORRO S.A.S.\nNIT :901150440-9\nRESPONSABLES DE IVA\n2892932-PBX 4806360\nCALLE 11 # 16-43\nFACTURA DE VENTA: C11 206136\nCODIGO DESCRIPCION\tCANT. VR.TOTAL\n004967 DETERGENTE FAB 1.00 6200 G\n004573 FILETE PECHUGA 1.00 19900 X\n005015 BROCOLI KILO\t0.48 2328 X\n005021 CEBOLLA DE HUEVO 0.40 880 X\n005107 ZANAHORIA KILO 0.66 1320 X\n004736 PAPA CAPIRA X\t1.08 1935 X\n005157 BOLSA DE\t1.00 500 X\n008777 BOLSAS/EMPAQUES 1.00 50 X\nINC Bolsa\t\t50\nSUBTOTAL\t33,113\nIMPUESTO\t50\nBASE\t32,073\nIVA\t990\nINC Bolsa Pilstica\t50\n>>>>> TOTAL\t33,113\nEFECTIVO\t50,100\nCAMBIO\t16,987\nDISCRIMINACION TARIFAS IVA\nTARI-A COMPRA\tBASE\tIVA\nX 26,863 26,863\t0\n19 % 6,200 5,210\t990\nArticulos:6.61\nFecha Fac:07/01/2020 11:19:53 AM\nImpresjon:07/01/2020 11:20:05 AM\nCajero(a):BIVIANA BETANCUR SUAREZ\nAuditoria:010102 0107 0119\nAUTORIZACION FACTURACION No.\n18762016141372 DE:06/08/2019 VIGENCIA: 18\nMESES, HABILITA NUMERO DESDE:C11 155963\nHASTA:C11 500000\nSERIAL CAJA02: 9GVG8V1\nDelfin Software - Dlp Systems\nwww.dlpsystems.co",
+  "order_date":"",
+  "payment_display_name":"Cash",
+  "payment_terms":"",
+  "payment_type":"cash",
+  "phone_number":"010102 0107 0119",
+  "purchase_order_number":"",
+  "reference_number":"VBJHG-9250",
+  "service_end_date":"",
+  "service_start_date":"",
+  "ship_date":"",
+  "shipping":0.0,
+  "subtotal":33113.0,
+  "tags":[
+
+  ],
+  "tax":990.0,
+  "tax_lines":[
+
+  ],
+  "tip":0.0,
+  "total":33113.0,
+  "total_weight":"",
+  "tracking_number":"",
+  "updated":"2021-07-12 01:01:00",
+  "vat_number":"901150440-9",
+  "vendor":{
+    "address":"",
+    "fax_number":"",
+    "name":"Supermercados Merkahorro S.a.s.",
+    "phone_number":"010102 0107 0119",
+    "raw_name":"SUPERMERCADOS MERKAHORRO S.A.S.",
+    "vendor_logo":"https://cdn.veryfi.com/logos/tmp/038634479.png",
+    "vendor_type":"Grocery"
+  },
+  "vendor_account_number":"",
+  "vendor_bank_name":"",
+  "vendor_bank_number":"",
+  "vendor_bank_swift":"",
+  "vendor_iban":"",
+  "warnings":[
+
+  ]
+}

package/types/main.d.ts

@@ -0,0 +1,270 @@
+/**
+ * Additional request parameters type
+ */
+export declare type VeryfiExtraArgs = Record<
+  string | number | symbol,
+  string | number | boolean
+>;
+
+/**
+ * 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;
+  duplicate_of?: null | number;
+  external_id?: null | string;
+  id?: null | number;
+  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;
+  line_items?: null | LineItem[];
+  notes?: null | string;
+  ocr_text?: null | string;
+  order_date?: null | string;
+  payment_display_name?: null | string;
+  payment_terms?: null | string;
+  payment_type?: null | string;
+  phone_number?: null | string;
+  purchase_order_number?: null | string;
+  rounding?: null | number;
+  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;
+  tax_lines?: null | TaxLine[];
+  tip?: null | number;
+  total?: null | number;
+  total_weight?: null | string;
+  tracking_number?: null | string;
+  updated?: null | string;
+  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;
+};
+
+declare type LineItem = {
+  date?: null | string;
+  description?: null | string;
+  discount?: null | number;
+  end_date?: null | string;
+  hsn?: null | string;
+  id?: null | number;
+  order?: null | number;
+  price?: null | number;
+  quantity?: null | number;
+  reference?: null | string;
+  section?: null | string;
+  sku?: null | string;
+  start_date?: null | string;
+  tags?: null | null[];
+  tax?: null | number;
+  tax_rate?: null | number;
+  total?: null | number;
+  type?: null | string;
+  unit_of_measure?: null | string;
+};
+
+declare type TaxLine = {
+  base?: null | number;
+  name?: null | string;
+  order?: null | number;
+  rate?: null | number;
+  total?: null | number;
+};
+
+declare type Vendor = {
+  address?: null | string;
+  category?: null | string;
+  email?: null | string;
+  fax_number?: null | string;
+  name?: null | string;
+  phone_number?: null | string;
+  raw_name?: null | string;
+  vendor_logo?: null | string;
+  vendor_reg_number?: null | string;
+  vendor_type?: null | string;
+  web?: 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} username Your Veryfi username
+   * @param {string} api_key Your Veryfi API key
+   * @param {string} base_url
+   * @param {string} api_version
+   * @param {number} timeout
+   */
+  constructor(
+    client_id: string,
+    client_secret: string,
+    username: string,
+    api_key: string,
+    base_url?: string,
+    api_version?: string,
+    timeout?: number
+  );
+
+  client_id: string;
+
+  client_secret: string;
+
+  username: string;
+
+  api_key: string;
+
+  base_url: string;
+
+  api_version: string;
+
+  CATEGORIES: string[];
+
+  private _get_headers;
+
+  private _get_url;
+
+  private _generate_signature;
+
+  private _request;
+
+  /**
+   * Get all documents
+   * @memberof Client
+   * @returns {Promise<VeryfiDocument>} Object of previously processed documents
+   */
+  public get_documents(): Promise<VeryfiDocument[]>;
+
+  /**
+   * Retrieve document by ID
+   * @memberof Client
+   * @param {string} document_id ID of the document you'd like to retrieve
+   * @returns {Promise<VeryfiDocument>} Object of data extracted from the document
+   */
+  public get_document(document_id: string): Promise<VeryfiDocument>;
+
+  /**
+   * Process a document and extract all the fields from it
+   * @example
+   * veryfi_client.process_document(
+   *   'file/path',
+   *   ['Entertainment', 'Food'],
+   *   true,
+   *   { extra: 'parameters' }
+   * )
+   * @memberof Client
+   * @param {string} file_path Path on disk to a file to submit for data extraction
+   * @param {string[]} categories List of categories Veryfi can use to categorize the document
+   * @param {boolean} delete_after_processing Delete this document from Veryfi after data has been extracted
+   * @param {VeryfiExtraArgs} kwargs Additional request parameters
+   * @returns {Promise<VeryfiDocument>} Object of data extracted from the document
+   */
+  public process_document(
+    file_path: string,
+    categories?: string[],
+    delete_after_processing?: boolean,
+    { ...kwargs }?: VeryfiExtraArgs
+  ): Promise<VeryfiDocument>;
+
+  /**
+   * Process document from url and extract all the fields from it.
+   * @memberof Client
+   * @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 {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 {VeryfiExtraArgs} kwargs Additional request parameters
+   * @return {Promise<VeryfiDocument>} Object of data extracted from the document
+   */
+  public process_document_url(
+    file_url?: 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>;
+
+  /**
+   * Delete document from Veryfi
+   * @memberof 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>;
+
+  /**
+   * Update data for a previously processed document, including almost any field like `vendor`, `date`, `notes` and etc.
+   * @example
+   * veryfi_client.update_document(
+   *   id,
+   *   { date: '2021-01-01', notes: 'look what I did' }
+   * )
+   * @memberof Client
+   * @param {string} document_id ID of the document you'd like to update
+   * @param {VeryfiExtraArgs} kwargs fields to update
+   * @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
+  ): Promise<VeryfiDocument>;
+}
+
+/**
+ * Create instance of a Client
+ * @class
+ * @param {string} client_id Your Veryfi client id
+ * @param {string} client_secret Your Veryfi client secret
+ * @param {string} username Your Veryfi username
+ * @param {string} api_key Your Veryfi API key
+ * @param {string} base_url
+ * @param {string} api_version
+ * @param {number} timeout
+ */
+export declare function Client(
+  client_id: string,
+  client_secret: string,
+  username: string,
+  api_key: string,
+  base_url?: string,
+  api_version?: string,
+  timeout?: number
+): Client;
+
+export default Client;