@veryfi/veryfi-sdk 1.2.0 → 1.2.2

package/lib/main.js

@@ -116,10 +116,11 @@ Client.prototype._generate_signature = function (payload_params, timestamp) {
  * @param {string} http_verb HTTP Method
  * @param {string} endpoint_name Endpoint name such as 'documents', 'users', etc.
  * @param {{}} request_arguments JSON payload to send to Veryfi
+ * @param params {{}} query params.
  * @param file_stream file stream of the document
  * @returns {JSON} A JSON of the response data.
  */
-Client.prototype._request = async function (http_verb, endpoint_name, request_arguments, file_stream = null) {
+Client.prototype._request = async function (http_verb, endpoint_name, request_arguments, params = {}, file_stream = null) {
     let has_files = (Boolean(file_stream));
     let headers = this._get_headers(has_files);
     let api_url = `${this._get_url()}/partner${endpoint_name}`;
@@ -145,7 +146,8 @@ Client.prototype._request = async function (http_verb, endpoint_name, request_ar
             url: api_url,
             headers: headers,
             data: request_arguments,
-            timeout: this.timeout * 1000
+            timeout: this.timeout * 1000,
+            params: params
         });
     } catch (response) {
         let errorStatus = response['response']['status'];
@@ -273,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.
  */
@@ -338,13 +340,18 @@ Client.prototype.update_document = async function (document_id, {...kwargs} = {}
 /**
  * Get all w2 documents.
  * @memberOf Client
+ * @param {int} page number, response is capped to maximum of 50 results per page.
  * @return {Array} An array of JSON with all w2 documents.
  */
-Client.prototype.get_w2_documents = async function () {
+Client.prototype.get_w2_documents = async function (page = null) {
     this._check_w2_version()
     let endpoint_name = "/w2s/"
     let request_arguments = {}
-    let response = await this._request("GET", endpoint_name, request_arguments)
+    let params = {}
+    if (page !== null) {
+        params = {"page": page}
+    }
+    let response = await this._request("GET", endpoint_name, request_arguments, params)
     return response['data']['results']
 }
 

package/lib/types/main.d.ts

@@ -211,20 +211,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>;
 

package/package.json

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