@veryfi/veryfi-sdk 1.4.8 → 1.5.0

package/lib/w2s/splitW2sBase64.js

@@ -0,0 +1,24 @@
+const Client = require('../client/constructor');
+/**
+ * Split and process a PDF with multiple W-2s from a base64 string. https://docs.veryfi.com/api/split-and-process-a-pdf-with-multiple-w-2-s/
+ *
+ * @memberof Client
+ * @param {String} file_name The file name including the extension
+ * @param {String} file_base64_string Base64-encoded file contents (raw or data URI)
+ * @param {Object} kwargs Additional request parameters
+ * @returns {JSON} API response data
+ */
+Client.prototype.split_w2s_from_base64 = async function (
+    file_name,
+    file_base64_string,
+    {...kwargs} = {}
+) {
+    let endpoint_name = "/w2s-set/";
+    let request_arguments = {
+        "file_name": file_name,
+        "file_data": file_base64_string,
+    };
+    request_arguments = Object.assign(request_arguments, kwargs);
+    let response = await this._request("POST", endpoint_name, request_arguments, null, false);
+    return response['data'];
+}

package/lib/w2s/splitW2sStream.js

@@ -0,0 +1,24 @@
+const Client = require('../client/constructor');
+/**
+ * Split and process a PDF with multiple W-2s from a file stream. https://docs.veryfi.com/api/split-and-process-a-pdf-with-multiple-w-2-s/
+ *
+ * @memberof Client
+ * @param {stream.Readable} file ReadStream of a file to submit
+ * @param {String} file_name The file name including the extension
+ * @param {Object} kwargs Additional request parameters
+ * @returns {JSON} API response data
+ */
+Client.prototype.split_w2s_from_stream = async function (
+    file,
+    file_name,
+    {...kwargs} = {}
+) {
+    let endpoint_name = "/w2s-set/";
+    let request_arguments = {
+        "file": file,
+        "file_name": file_name,
+    };
+    request_arguments = Object.assign(request_arguments, kwargs);
+    let response = await this._request("POST", endpoint_name, request_arguments, null, true);
+    return response['data'];
+}

package/lib/w2s/splitW2sUrl.js

@@ -0,0 +1,24 @@
+const Client = require('../client/constructor');
+/**
+ * Split and process a PDF with multiple W-2s from a URL. https://docs.veryfi.com/api/split-and-process-a-pdf-with-multiple-w-2-s/
+ *
+ * @memberof Client
+ * @param {string|null} file_url Required if file_urls isn't specified. Publicly accessible URL to a file.
+ * @param {string[]} file_urls Required if file_url isn't specified. List of publicly accessible URLs.
+ * @param {Object} kwargs Additional request parameters
+ * @returns {JSON} API response data
+ */
+Client.prototype.split_w2s_from_url = async function (
+    file_url = null,
+    file_urls = null,
+    {...kwargs} = {}
+) {
+    let endpoint_name = "/w2s-set/";
+    let request_arguments = {
+        "file_url": file_url,
+        "file_urls": file_urls,
+    };
+    request_arguments = Object.assign(request_arguments, kwargs);
+    let response = await this._request("POST", endpoint_name, request_arguments, null, false);
+    return response['data'];
+}

package/lib/w2s/tags/addW2Tag.js

@@ -0,0 +1,15 @@
+const Client = require('../../client/constructor');
+/**
+ * Add a tag to a W-2. https://docs.veryfi.com/api/add-a-tag-to-a-w-2/
+ *
+ * @memberof Client
+ * @param {string} document_id ID of the document
+ * @param {string} tag Tag name to add
+ * @returns {JSON} Tag response
+ */
+Client.prototype.add_w2_tag = async function (document_id, tag) {
+    let endpoint_name = `/w2s/${document_id}/tags/`;
+    let request_arguments = {"name": tag};
+    let response = await this._request("PUT", endpoint_name, request_arguments);
+    return response['data'];
+}

package/lib/w2s/tags/addW2Tags.js

@@ -0,0 +1,15 @@
+const Client = require('../../client/constructor');
+/**
+ * Add tags to a W-2. https://docs.veryfi.com/api/add-tags-to-a-w-2/
+ *
+ * @memberof Client
+ * @param {string} document_id ID of the document
+ * @param {string[]} tags Tag names to add
+ * @returns {JSON} Tags response
+ */
+Client.prototype.add_w2_tags = async function (document_id, tags) {
+    let endpoint_name = `/w2s/${document_id}/tags/`;
+    let request_arguments = {"tags": tags};
+    let response = await this._request("POST", endpoint_name, request_arguments);
+    return response['data'];
+}

package/lib/w2s/tags/deleteW2Tag.js

@@ -0,0 +1,13 @@
+const Client = require('../../client/constructor');
+/**
+ * Unlink a tag from a W-2. https://docs.veryfi.com/api/unlink-a-tag-from-a-w-2/
+ *
+ * @memberof Client
+ * @param {string} document_id ID of the document
+ * @param {string} tag_id ID of the tag to unlink
+ * @returns {JSON} Delete response
+ */
+Client.prototype.delete_w2_tag = async function (document_id, tag_id) {
+    let endpoint_name = `/w2s/${document_id}/tags/${tag_id}/`;
+    return this._request("DELETE", endpoint_name, {});
+}

package/lib/w2s/tags/deleteW2Tags.js

@@ -0,0 +1,12 @@
+const Client = require('../../client/constructor');
+/**
+ * Unlink all tags from a W-2. https://docs.veryfi.com/api/unlink-all-tags-from-a-w-2/
+ *
+ * @memberof Client
+ * @param {string} document_id ID of the document
+ * @returns {JSON} Delete response
+ */
+Client.prototype.delete_w2_tags = async function (document_id) {
+    let endpoint_name = `/w2s/${document_id}/tags/`;
+    return this._request("DELETE", endpoint_name, {});
+}

package/lib/w2s/tags/getW2Tags.js

@@ -0,0 +1,14 @@
+const Client = require('../../client/constructor');
+/**
+ * Get tags assigned to a W-2. https://docs.veryfi.com/api/get-w-2-tags/
+ *
+ * @memberof Client
+ * @param {string} document_id ID of the document
+ * @param {Object} kwargs Additional request parameters
+ * @returns {JSON} List of tags
+ */
+Client.prototype.get_w2_tags = async function (document_id, {...kwargs} = {}) {
+    let endpoint_name = `/w2s/${document_id}/tags/`;
+    let response = await this._request("GET", endpoint_name, {}, kwargs, false);
+    return response['data'];
+}

package/lib/w2s/updateW2.js

@@ -0,0 +1,14 @@
+const Client = require('../client/constructor');
+/**
+ * Update a W-2. https://docs.veryfi.com/api/w2s/update-a-w-2/
+ *
+ * @memberof Client
+ * @param {string} document_id ID of the resource
+ * @param {Object} kwargs Fields to update
+ * @returns {JSON} Updated resource
+ */
+Client.prototype.update_w2 = async function (document_id, {...kwargs} = {}) {
+    let endpoint_name = `/w2s/${document_id}/`;
+    let response = await this._request("PUT", endpoint_name, kwargs);
+    return response['data'];
+}

package/lib/w8bene/getW8BENE.js

@@ -15,10 +15,10 @@ Client.prototype.get_w8bene = async function (
     {...kwargs} = {}
 ) {
     let endpoint_name = `/w-8ben-e/${document_id}/`;
-    let request_arguments = {
+    let query = Object.assign({
         "bounding_boxes": bounding_boxes,
         "confidence_details": confidence_details
-    };
-    let document = await this._request("GET", endpoint_name, request_arguments, kwargs, false);
+    }, kwargs);
+    let document = await this._request("GET", endpoint_name, {}, query, false);
     return document['data'];
 }

package/lib/w8bene/getW8BENEs.js

@@ -17,12 +17,12 @@ Client.prototype.get_w8benes = async function (
     {...kwargs} = {}
 ) {
     let endpoint_name = `/w-8ben-e/`;
-    let request_arguments = {
+    let query = Object.assign({
         "page": page,
         "page_size": page_size,
         "bounding_boxes": bounding_boxes,
         "confidence_details": confidence_details
-    };
-    let document = await this._request("GET", endpoint_name, request_arguments, kwargs, false);
+    }, kwargs);
+    let document = await this._request("GET", endpoint_name, {}, query, false);
     return document['data'];
 }

package/lib/w8bene/tags/addW8beneTag.js

@@ -0,0 +1,15 @@
+const Client = require('../../client/constructor');
+/**
+ * Add a tag to a W-8BEN-E. https://docs.veryfi.com/api/add-a-tag-to-a-w-8-ben-e/
+ *
+ * @memberof Client
+ * @param {string} document_id ID of the document
+ * @param {string} tag Tag name to add
+ * @returns {JSON} Tag response
+ */
+Client.prototype.add_w8bene_tag = async function (document_id, tag) {
+    let endpoint_name = `/w-8ben-e/${document_id}/tags/`;
+    let request_arguments = {"name": tag};
+    let response = await this._request("PUT", endpoint_name, request_arguments);
+    return response['data'];
+}

package/lib/w8bene/tags/addW8beneTags.js

@@ -0,0 +1,15 @@
+const Client = require('../../client/constructor');
+/**
+ * Add tags to a W-8BEN-E. https://docs.veryfi.com/api/add-tags-to-a-w-8-ben-e/
+ *
+ * @memberof Client
+ * @param {string} document_id ID of the document
+ * @param {string[]} tags Tag names to add
+ * @returns {JSON} Tags response
+ */
+Client.prototype.add_w8bene_tags = async function (document_id, tags) {
+    let endpoint_name = `/w-8ben-e/${document_id}/tags/`;
+    let request_arguments = {"tags": tags};
+    let response = await this._request("POST", endpoint_name, request_arguments);
+    return response['data'];
+}

package/lib/w8bene/tags/deleteW8beneTag.js

@@ -0,0 +1,13 @@
+const Client = require('../../client/constructor');
+/**
+ * Unlink a tag from a W-8BEN-E. https://docs.veryfi.com/api/unlink-a-tag-from-a-w-8-ben-e/
+ *
+ * @memberof Client
+ * @param {string} document_id ID of the document
+ * @param {string} tag_id ID of the tag to unlink
+ * @returns {JSON} Delete response
+ */
+Client.prototype.delete_w8bene_tag = async function (document_id, tag_id) {
+    let endpoint_name = `/w-8ben-e/${document_id}/tags/${tag_id}/`;
+    return this._request("DELETE", endpoint_name, {});
+}

package/lib/w8bene/tags/deleteW8beneTags.js

@@ -0,0 +1,12 @@
+const Client = require('../../client/constructor');
+/**
+ * Unlink all tags from a W-8BEN-E. https://docs.veryfi.com/api/unlink-all-tags-from-a-w-8-ben-e/
+ *
+ * @memberof Client
+ * @param {string} document_id ID of the document
+ * @returns {JSON} Delete response
+ */
+Client.prototype.delete_w8bene_tags = async function (document_id) {
+    let endpoint_name = `/w-8ben-e/${document_id}/tags/`;
+    return this._request("DELETE", endpoint_name, {});
+}

package/lib/w8bene/tags/getW8beneTags.js

@@ -0,0 +1,14 @@
+const Client = require('../../client/constructor');
+/**
+ * Get tags assigned to a W-8BEN-E. https://docs.veryfi.com/api/get-w-8-ben-e-tags/
+ *
+ * @memberof Client
+ * @param {string} document_id ID of the document
+ * @param {Object} kwargs Additional request parameters
+ * @returns {JSON} List of tags
+ */
+Client.prototype.get_w8bene_tags = async function (document_id, {...kwargs} = {}) {
+    let endpoint_name = `/w-8ben-e/${document_id}/tags/`;
+    let response = await this._request("GET", endpoint_name, {}, kwargs, false);
+    return response['data'];
+}

package/lib/w8bene/updateW8BENE.js

@@ -0,0 +1,14 @@
+const Client = require('../client/constructor');
+/**
+ * Update a W-8BEN-E. https://docs.veryfi.com/api/w-8ben-e/update-a-w-8-ben-e/
+ *
+ * @memberof Client
+ * @param {string} document_id ID of the resource
+ * @param {Object} kwargs Fields to update
+ * @returns {JSON} Updated resource
+ */
+Client.prototype.update_w8bene = async function (document_id, {...kwargs} = {}) {
+    let endpoint_name = `/w-8ben-e/${document_id}/`;
+    let response = await this._request("PUT", endpoint_name, kwargs);
+    return response['data'];
+}

package/lib/w9s/getW9.js

@@ -15,10 +15,10 @@ Client.prototype.get_w9 = async function (
     {...kwargs} = {}
 ) {
     let endpoint_name = `/w9s/${document_id}/`;
-    let request_arguments = {
+    let query = Object.assign({
         "bounding_boxes": bounding_boxes,
         "confidence_details": confidence_details
-    };
-    let document = await this._request("GET", endpoint_name, request_arguments, kwargs, false);
+    }, kwargs);
+    let document = await this._request("GET", endpoint_name, {}, query, false);
     return document['data'];
 }

package/lib/w9s/getW9s.js

@@ -17,12 +17,12 @@ Client.prototype.get_w9s = async function (
     {...kwargs} = {}
 ) {
     let endpoint_name = `/w9s/`;
-    let request_arguments = {
+    let query = Object.assign({
         "page": page,
         "page_size": page_size,
         "bounding_boxes": bounding_boxes,
         "confidence_details": confidence_details
-    };
-    let document = await this._request("GET", endpoint_name, request_arguments, kwargs, false);
+    }, kwargs);
+    let document = await this._request("GET", endpoint_name, {}, query, false);
     return document['data'];
 }

package/lib/w9s/tags/addW9Tag.js

@@ -0,0 +1,15 @@
+const Client = require('../../client/constructor');
+/**
+ * Add a tag to a W-9. https://docs.veryfi.com/api/add-a-tag-to-a-w-9/
+ *
+ * @memberof Client
+ * @param {string} document_id ID of the document
+ * @param {string} tag Tag name to add
+ * @returns {JSON} Tag response
+ */
+Client.prototype.add_w9_tag = async function (document_id, tag) {
+    let endpoint_name = `/w9s/${document_id}/tags/`;
+    let request_arguments = {"name": tag};
+    let response = await this._request("PUT", endpoint_name, request_arguments);
+    return response['data'];
+}

package/lib/w9s/tags/addW9Tags.js

@@ -0,0 +1,15 @@
+const Client = require('../../client/constructor');
+/**
+ * Add tags to a W-9. https://docs.veryfi.com/api/add-tags-to-a-w-9/
+ *
+ * @memberof Client
+ * @param {string} document_id ID of the document
+ * @param {string[]} tags Tag names to add
+ * @returns {JSON} Tags response
+ */
+Client.prototype.add_w9_tags = async function (document_id, tags) {
+    let endpoint_name = `/w9s/${document_id}/tags/`;
+    let request_arguments = {"tags": tags};
+    let response = await this._request("POST", endpoint_name, request_arguments);
+    return response['data'];
+}

package/lib/w9s/tags/deleteW9Tag.js

@@ -0,0 +1,13 @@
+const Client = require('../../client/constructor');
+/**
+ * Unlink a tag from a W-9. https://docs.veryfi.com/api/unlink-a-tag-from-a-w-9/
+ *
+ * @memberof Client
+ * @param {string} document_id ID of the document
+ * @param {string} tag_id ID of the tag to unlink
+ * @returns {JSON} Delete response
+ */
+Client.prototype.delete_w9_tag = async function (document_id, tag_id) {
+    let endpoint_name = `/w9s/${document_id}/tags/${tag_id}/`;
+    return this._request("DELETE", endpoint_name, {});
+}

package/lib/w9s/tags/deleteW9Tags.js

@@ -0,0 +1,12 @@
+const Client = require('../../client/constructor');
+/**
+ * Unlink all tags from a W-9. https://docs.veryfi.com/api/unlink-all-tags-from-a-w-9/
+ *
+ * @memberof Client
+ * @param {string} document_id ID of the document
+ * @returns {JSON} Delete response
+ */
+Client.prototype.delete_w9_tags = async function (document_id) {
+    let endpoint_name = `/w9s/${document_id}/tags/`;
+    return this._request("DELETE", endpoint_name, {});
+}

package/lib/w9s/tags/getW9Tags.js

@@ -0,0 +1,14 @@
+const Client = require('../../client/constructor');
+/**
+ * Get tags assigned to a W-9. https://docs.veryfi.com/api/get-w-9-tags/
+ *
+ * @memberof Client
+ * @param {string} document_id ID of the document
+ * @param {Object} kwargs Additional request parameters
+ * @returns {JSON} List of tags
+ */
+Client.prototype.get_w9_tags = async function (document_id, {...kwargs} = {}) {
+    let endpoint_name = `/w9s/${document_id}/tags/`;
+    let response = await this._request("GET", endpoint_name, {}, kwargs, false);
+    return response['data'];
+}

package/lib/w9s/updateW9.js

@@ -0,0 +1,14 @@
+const Client = require('../client/constructor');
+/**
+ * Update a W-9. https://docs.veryfi.com/api/w9s/update-a-w-9/
+ *
+ * @memberof Client
+ * @param {string} document_id ID of the resource
+ * @param {Object} kwargs Fields to update
+ * @returns {JSON} Updated resource
+ */
+Client.prototype.update_w9 = async function (document_id, {...kwargs} = {}) {
+    let endpoint_name = `/w9s/${document_id}/`;
+    let response = await this._request("PUT", endpoint_name, kwargs);
+    return response['data'];
+}

package/package.json

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