@veryfi/veryfi-sdk 1.4.6 → 1.5.0

package/lib/parse/processMarkdownDocumentSetStream.js

@@ -0,0 +1,24 @@
+const Client = require('../client/constructor');
+/**
+ * Process a markdown document set from a file stream. https://docs.veryfi.com/api/parse/process-a-markdown-document-set/
+ *
+ * @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.process_markdown_document_set_from_stream = async function (
+    file,
+    file_name,
+    {...kwargs} = {}
+) {
+    let endpoint_name = "/parse-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/parse/processMarkdownDocumentSetUrl.js

@@ -0,0 +1,24 @@
+const Client = require('../client/constructor');
+/**
+ * Process a markdown document set from a URL. https://docs.veryfi.com/api/parse/process-a-markdown-document-set/
+ *
+ * @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.process_markdown_document_set_from_url = async function (
+    file_url = null,
+    file_urls = null,
+    {...kwargs} = {}
+) {
+    let endpoint_name = "/parse-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/parse/processMarkdownDocumentStream.js

@@ -0,0 +1,24 @@
+const Client = require('../client/constructor');
+/**
+ * Convert a document to markdown from a file stream. https://docs.veryfi.com/api/parse/convert-a-document-to-markdown/
+ *
+ * @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.process_markdown_document_from_stream = async function (
+    file,
+    file_name,
+    {...kwargs} = {}
+) {
+    let endpoint_name = "/parse/";
+    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/parse/processMarkdownDocumentUrl.js

@@ -0,0 +1,24 @@
+const Client = require('../client/constructor');
+/**
+ * Convert a document to markdown from a URL. https://docs.veryfi.com/api/parse/convert-a-document-to-markdown/
+ *
+ * @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.process_markdown_document_from_url = async function (
+    file_url = null,
+    file_urls = null,
+    {...kwargs} = {}
+) {
+    let endpoint_name = "/parse/";
+    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/parse/updateMarkdownDocument.js

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

package/lib/platform/getOcrCounts.js

@@ -0,0 +1,20 @@
+const Client = require('../client/constructor');
+/**
+ * Get ocr-counts. https://docs.veryfi.com/api/get-ocr-counts/
+ *
+ * @memberof Client
+ * @param {string} ocr_type OCR type (pepsico_codes or pepsico_caps)
+ * @param {Object} kwargs Additional request parameters
+ * @returns {JSON} API response data
+ */
+Client.prototype.get_ocr_counts = async function (
+    ocr_type = null,
+    {...kwargs} = {}
+) {
+    let endpoint_name = "/ocr-counts/";
+    let query = Object.assign({
+        "ocr_type": ocr_type,
+    }, kwargs);
+    let response = await this._request("GET", endpoint_name, {}, query, false);
+    return response['data'];
+}

package/lib/platform/getOpenApiSchema.js

@@ -0,0 +1,17 @@
+const Client = require('../client/constructor');
+/**
+ * Get OpenAPI schema. https://docs.veryfi.com/api/get-open-api-schema/
+ *
+ * @memberof Client
+ * @param {Object} kwargs Additional request parameters
+ * @returns {JSON} API response data
+ */
+Client.prototype.get_open_api_schema = async function (
+    {...kwargs} = {}
+) {
+    let endpoint_name = "/documents/schema/";
+    let query = Object.assign({
+    }, kwargs);
+    let response = await this._request("GET", endpoint_name, {}, query, false);
+    return response['data'];
+}

package/lib/platform/getReleaseNotifications.js

@@ -0,0 +1,13 @@
+const Client = require('../client/constructor');
+/**
+ * Get release notifications. https://docs.veryfi.com/api/get-release-notifications/
+ *
+ * @memberof Client
+ * @param {Object} kwargs Additional request parameters
+ * @returns {JSON} Release notifications
+ */
+Client.prototype.get_release_notifications = async function ({...kwargs} = {}) {
+    let endpoint_name = "/release-notifications/";
+    let response = await this._request("GET", endpoint_name, {}, kwargs, false, { api_version: "v1", skip_partner: true });
+    return response['data'];
+}

package/lib/settings/addWebhook.js

@@ -0,0 +1,20 @@
+const Client = require('../client/constructor');
+/**
+ * Add a webhook. https://docs.veryfi.com/api/settings/add-a-webhook/
+ *
+ * @memberof Client
+ * @param {*} url Request field
+ * @param {Object} kwargs Additional request parameters
+ * @returns {JSON} API response data
+ */
+Client.prototype.add_webhook = async function (
+    url,
+    {...kwargs} = {}
+) {
+    let endpoint_name = "/settings/webhooks/";
+    let request_arguments = Object.assign({
+        "url": url,
+    }, kwargs);
+    let response = await this._request("POST", endpoint_name, request_arguments);
+    return response['data'];
+}

package/lib/settings/confirmWebhook.js

@@ -0,0 +1,23 @@
+const Client = require('../client/constructor');
+/**
+ * Confirm a webhook. https://docs.veryfi.com/api/settings/confirm-a-webhook/
+ *
+ * @memberof Client
+ * @param {*} url Request field
+ * @param {*} secret Request field
+ * @param {Object} kwargs Additional request parameters
+ * @returns {JSON} API response data
+ */
+Client.prototype.confirm_webhook = async function (
+    url,
+    secret,
+    {...kwargs} = {}
+) {
+    let endpoint_name = "/settings/webhooks/confirm/";
+    let request_arguments = Object.assign({
+        "url": url,
+        "secret": secret,
+    }, kwargs);
+    let response = await this._request("POST", endpoint_name, request_arguments);
+    return response['data'];
+}

package/lib/settings/createApiKey.js

@@ -0,0 +1,20 @@
+const Client = require('../client/constructor');
+/**
+ * Create api-key. https://docs.veryfi.com/api/settings/create-api-key/
+ *
+ * @memberof Client
+ * @param {*} name Request field
+ * @param {Object} kwargs Additional request parameters
+ * @returns {JSON} API response data
+ */
+Client.prototype.create_api_key = async function (
+    name,
+    {...kwargs} = {}
+) {
+    let endpoint_name = "/settings/api-keys/";
+    let request_arguments = Object.assign({
+        "name": name,
+    }, kwargs);
+    let response = await this._request("POST", endpoint_name, request_arguments, null, false, { api_version: "v1" });
+    return response['data'];
+}

package/lib/settings/createClientKeys.js

@@ -0,0 +1,17 @@
+const Client = require('../client/constructor');
+/**
+ * Create client-keys. https://docs.veryfi.com/api/settings/create-client-keys/
+ *
+ * @memberof Client
+ * @param {Object} kwargs Additional request parameters
+ * @returns {JSON} API response data
+ */
+Client.prototype.create_client_keys = async function (
+    {...kwargs} = {}
+) {
+    let endpoint_name = "/client-keys/";
+    let request_arguments = Object.assign({
+    }, kwargs);
+    let response = await this._request("POST", endpoint_name, request_arguments);
+    return response['data'];
+}

package/lib/settings/deleteClientKey.js

@@ -0,0 +1,12 @@
+const Client = require('../client/constructor');
+/**
+ * Remove a client-key. https://docs.veryfi.com/api/settings/remove-a-client-key/
+ *
+ * @memberof Client
+ * @param {string} id Resource id
+ * @returns {JSON} Delete response
+ */
+Client.prototype.delete_client_key = async function (id) {
+    let endpoint_name = `/client-keys/${id}/`;
+    return this._request("DELETE", endpoint_name, {});
+}

package/lib/settings/deleteTlsCertificate.js

@@ -0,0 +1,12 @@
+const Client = require('../client/constructor');
+/**
+ * Delete a Tls Certificate. https://docs.veryfi.com/api/delete-a-tls-certificate/
+ *
+ * @memberof Client
+ * @param {string} certificate_id Resource id
+ * @returns {JSON} Delete response
+ */
+Client.prototype.delete_tls_certificate = async function (certificate_id) {
+    let endpoint_name = `/settings/tls-certificate/${certificate_id}/`;
+    return this._request("DELETE", endpoint_name, {});
+}

package/lib/settings/getApiKey.js

@@ -0,0 +1,17 @@
+const Client = require('../client/constructor');
+/**
+ * Retrieve api-key. https://docs.veryfi.com/api/settings/retrieve-api-key/
+ *
+ * @memberof Client
+ * @param {string} id Resource id
+ * @param {Object} kwargs Additional request parameters
+ * @returns {JSON} API response data
+ */
+Client.prototype.get_api_key = async function (
+    id,
+    {...kwargs} = {}
+) {
+    let endpoint_name = `/settings/api-keys/${id}/`;
+    let response = await this._request("GET", endpoint_name, {}, kwargs, false, { api_version: "v1" });
+    return response['data'];
+}

package/lib/settings/getApiKeyPermissions.js

@@ -0,0 +1,15 @@
+const Client = require('../client/constructor');
+/**
+ * Available permissions. https://docs.veryfi.com/api/settings/available-permissions/
+ *
+ * @memberof Client
+ * @param {Object} kwargs Additional request parameters
+ * @returns {JSON} API response data
+ */
+Client.prototype.get_api_key_permissions = async function (
+    {...kwargs} = {}
+) {
+    let endpoint_name = "/settings/api-keys/available-permissions/";
+    let response = await this._request("GET", endpoint_name, {}, kwargs, false, { api_version: "v1" });
+    return response['data'];
+}

package/lib/settings/getApiKeys.js

@@ -0,0 +1,15 @@
+const Client = require('../client/constructor');
+/**
+ * Retrieve api-keys list. https://docs.veryfi.com/api/settings/retrieve-api-keys-list/
+ *
+ * @memberof Client
+ * @param {Object} kwargs Additional request parameters
+ * @returns {JSON} API response data
+ */
+Client.prototype.get_api_keys = async function (
+    {...kwargs} = {}
+) {
+    let endpoint_name = "/settings/api-keys/";
+    let response = await this._request("GET", endpoint_name, {}, kwargs, false, { api_version: "v1" });
+    return response['data'];
+}

package/lib/settings/getClientKeys.js

@@ -0,0 +1,15 @@
+const Client = require('../client/constructor');
+/**
+ * Retrieve client-keys list. https://docs.veryfi.com/api/settings/retrieve-client-keys-list/
+ *
+ * @memberof Client
+ * @param {Object} kwargs Additional request parameters
+ * @returns {JSON} API response data
+ */
+Client.prototype.get_client_keys = async function (
+    {...kwargs} = {}
+) {
+    let endpoint_name = "/client-keys/";
+    let response = await this._request("GET", endpoint_name, {}, kwargs, false);
+    return response['data'];
+}

package/lib/settings/getTlsCertificates.js

@@ -0,0 +1,15 @@
+const Client = require('../client/constructor');
+/**
+ * Get Tls Certificates. https://docs.veryfi.com/api/get-tls-certificates/
+ *
+ * @memberof Client
+ * @param {Object} kwargs Additional request parameters
+ * @returns {JSON} API response data
+ */
+Client.prototype.get_tls_certificates = async function (
+    {...kwargs} = {}
+) {
+    let endpoint_name = "/settings/tls-certificate/";
+    let response = await this._request("GET", endpoint_name, {}, kwargs, false);
+    return response['data'];
+}

package/lib/settings/getWebhooks.js

@@ -0,0 +1,15 @@
+const Client = require('../client/constructor');
+/**
+ * Get webhooks. https://docs.veryfi.com/api/settings/get-webhooks/
+ *
+ * @memberof Client
+ * @param {Object} kwargs Additional request parameters
+ * @returns {JSON} API response data
+ */
+Client.prototype.get_webhooks = async function (
+    {...kwargs} = {}
+) {
+    let endpoint_name = "/settings/webhooks/";
+    let response = await this._request("GET", endpoint_name, {}, kwargs, false);
+    return response['data'];
+}

package/lib/settings/processTlsCertificate.js

@@ -0,0 +1,17 @@
+const Client = require('../client/constructor');
+/**
+ * Process a Tls Certificate. https://docs.veryfi.com/api/process-a-tls-certificate/
+ *
+ * @memberof Client
+ * @param {Object} kwargs Additional request parameters
+ * @returns {JSON} API response data
+ */
+Client.prototype.process_tls_certificate = async function (
+    {...kwargs} = {}
+) {
+    let endpoint_name = "/settings/tls-certificate/";
+    let request_arguments = Object.assign({
+    }, kwargs);
+    let response = await this._request("POST", endpoint_name, request_arguments);
+    return response['data'];
+}

package/lib/settings/resetClientKeys.js

@@ -0,0 +1,17 @@
+const Client = require('../client/constructor');
+/**
+ * Reset client-keys. https://docs.veryfi.com/api/settings/reset-client-keys/
+ *
+ * @memberof Client
+ * @param {Object} kwargs Additional request parameters
+ * @returns {JSON} API response data
+ */
+Client.prototype.reset_client_keys = async function (
+    {...kwargs} = {}
+) {
+    let endpoint_name = "/client-keys/reset/";
+    let request_arguments = Object.assign({
+    }, kwargs);
+    let response = await this._request("POST", endpoint_name, request_arguments);
+    return response['data'];
+}

package/lib/settings/revokeApiKey.js

@@ -0,0 +1,12 @@
+const Client = require('../client/constructor');
+/**
+ * Revoke api-key. https://docs.veryfi.com/api/settings/revoke-api-key/
+ *
+ * @memberof Client
+ * @param {string} id Resource id
+ * @returns {JSON} Delete response
+ */
+Client.prototype.revoke_api_key = async function (id) {
+    let endpoint_name = `/settings/api-keys/${id}/`;
+    return this._request("DELETE", endpoint_name, {}, {}, false, { api_version: "v1" });
+}

package/lib/settings/rotateApiKey.js

@@ -0,0 +1,14 @@
+const Client = require('../client/constructor');
+/**
+ * Rotate api-key. https://docs.veryfi.com/api/settings/rotate-api-key/
+ *
+ * @memberof Client
+ * @param {string} id API key id
+ * @param {Object} kwargs Additional request parameters
+ * @returns {JSON} Rotated API key
+ */
+Client.prototype.rotate_api_key = async function (id, {...kwargs} = {}) {
+    let endpoint_name = `/settings/api-keys/${id}/rotate/`;
+    let response = await this._request("POST", endpoint_name, kwargs, null, false, { api_version: "v1" });
+    return response['data'];
+}

package/lib/settings/updateApiKey.js

@@ -0,0 +1,19 @@
+const Client = require('../client/constructor');
+/**
+ * Update api-key. https://docs.veryfi.com/api/settings/update-api-key/
+ *
+ * @memberof Client
+ * @param {string} id Resource id
+ * @param {Object} kwargs Additional request parameters
+ * @returns {JSON} API response data
+ */
+Client.prototype.update_api_key = async function (
+    id,
+    {...kwargs} = {}
+) {
+    let endpoint_name = `/settings/api-keys/${id}/`;
+    let request_arguments = Object.assign({
+    }, kwargs);
+    let response = await this._request("PUT", endpoint_name, request_arguments, null, false, { api_version: "v1" });
+    return response['data'];
+}

package/lib/settings/verifyApiKey.js

@@ -0,0 +1,15 @@
+const Client = require('../client/constructor');
+/**
+ * Verify the calling key. https://docs.veryfi.com/api/settings/verify-the-calling-key/
+ *
+ * @memberof Client
+ * @param {Object} kwargs Additional request parameters
+ * @returns {JSON} API response data
+ */
+Client.prototype.verify_api_key = async function (
+    {...kwargs} = {}
+) {
+    let endpoint_name = "/settings/api-keys/verify/";
+    let response = await this._request("GET", endpoint_name, {}, kwargs, false, { api_version: "v1" });
+    return response['data'];
+}

package/lib/split/getSplitDocument.js

@@ -7,8 +7,7 @@ const Client = require('../client/constructor');
  * @returns {JSON} Data extracted from the Document
  */
 Client.prototype.get_split_document = async function (document_id,  {...kwargs} = {}) {
-    let endpoint_name = `/documents-set//${document_id}/`;
-    let request_arguments = {"id": document_id};
-    let document = await this._request("GET", endpoint_name, request_arguments, kwargs, false);
+    let endpoint_name = `/documents-set/${document_id}/`;
+    let document = await this._request("GET", endpoint_name, {}, kwargs, false);
     return document['data'];
 }

package/lib/split/getSplitDocuments.js

@@ -13,11 +13,11 @@ Client.prototype.get_split_documents = async function (
     {...kwargs} = {}
 ) {
     let endpoint_name = "/documents-set/";
-    let request_arguments = {
+    let query = Object.assign({
         "page": page,
         "page_size": page_size
-    };
-    let documents = await this._request("GET", endpoint_name, request_arguments, kwargs, false);
+    }, kwargs);
+    let documents = await this._request("GET", endpoint_name, {}, query, false);
     if ("data" in documents) {
         documents = documents["data"];
     }

package/lib/split/splitDocument.js

@@ -0,0 +1,16 @@
+const Client = require('../client/constructor');
+const path = require('path');
+const fs = require('fs');
+/**
+ * Split and process a PDF. https://docs.veryfi.com/api/receipts-invoices/split-and-process-a-pdf/
+ *
+ * @memberof Client
+ * @param {String} file_path Path on disk to a PDF or zip to split
+ * @param {Object} kwargs Additional request parameters (categories, tags, max_pages_to_process, external_id, package_path, bucket)
+ * @returns {JSON} Split set response
+ */
+Client.prototype.split_document = async function (file_path, {...kwargs} = {}) {
+    let file = fs.createReadStream(file_path);
+    let file_name = path.basename(file_path);
+    return this.split_document_from_stream(file, file_name, kwargs);
+}

package/lib/split/splitDocumentStream.js

@@ -0,0 +1,19 @@
+const Client = require('../client/constructor');
+/**
+ * Split and process a PDF from a file stream. https://docs.veryfi.com/api/receipts-invoices/split-and-process-a-pdf/
+ *
+ * @memberof Client
+ * @param {stream.Readable} file ReadStream of a PDF or zip to split
+ * @param {String} file_name The file name including the extension
+ * @param {Object} kwargs Additional request parameters (categories, tags, max_pages_to_process, external_id, package_path, bucket)
+ * @returns {JSON} Split set response
+ */
+Client.prototype.split_document_from_stream = async function (file, file_name, {...kwargs} = {}) {
+    let endpoint_name = "/documents-set/";
+    let request_arguments = Object.assign({
+        "file": file,
+        "file_name": file_name
+    }, kwargs);
+    let response = await this._request("POST", endpoint_name, request_arguments, null, true);
+    return response['data'];
+}

package/lib/split/splitDocumentUrl.js

@@ -7,7 +7,7 @@ const Client = require('../client/constructor');
  * @memberof Client
  * @param {string|null} file_url Required if file_urls isn't specified. Publicly accessible URL to a file, e.g. "https://cdn.example.com/receipt.jpg".
  * @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 {Object} kwargs Additional request parameters
+ * @param {Object} kwargs Additional request parameters (categories, tags, max_pages_to_process, external_id, package_path, bucket)
  * @return {JSON} Data extracted from the document.
  */
 Client.prototype.split_document_from_url = async function (