refactor and add missing endpoints

Author: Kaevan89

veryfi/_documents/__init__.py

@@ -0,0 +1,73 @@
+from typing import *
+
+from veryfi.client_base import Client
+
+
+class LineItems:
+    def __init__(self, client: Client):
+        self.client = client
+
+    def get_line_items(self, document_id):
+        """
+        Retrieve all line items for a document.
+        https://docs.veryfi.com/api/receipts-invoices/get-document-line-items/
+
+        :param document_id: ID of the document you'd like to retrieve
+        :return: List of line items extracted from the document
+        """
+        return self.client._request("GET", f"/documents/{document_id}/line-items/")
+
+    def get_line_item(self, document_id, line_item_id):
+        """
+        Retrieve a line item for existing document by ID.
+        https://docs.veryfi.com/api/receipts-invoices/get-a-line-item/
+
+        :param document_id: ID of the document you'd like to retrieve
+        :param line_item_id: ID of the line item you'd like to retrieve
+        :return: Line item extracted from the document
+        """
+        return self.client._request("GET", f"/documents/{document_id}/line-items/{line_item_id}")
+
+    def add_line_item(self, document_id: int, payload: Dict) -> Dict:
+        """
+        Add a new line item on an existing document.
+        https://docs.veryfi.com/api/receipts-invoices/create-a-line-item/
+
+        :param document_id: ID of the document you'd like to update
+        :param payload: line item object to add
+        :return: Added line item data
+        """
+        return self.client._request("POST", f"/documents/{document_id}/line-items/", payload)
+
+    def update_line_item(self, document_id: int, line_item_id: int, payload: Dict) -> Dict:
+        """
+        Update an existing line item on an existing document.
+        https://docs.veryfi.com/api/receipts-invoices/update-a-line-item/
+
+        :param document_id: ID of the document you'd like to update
+        :param line_item_id: ID of the line item you'd like to update
+        :param payload: line item object to update
+        :return: Line item data with updated fields, if fields are writable. Otherwise line item data with unchanged fields.
+        """
+        return self.client._request(
+            "PUT", f"/documents/{document_id}/line-items/{line_item_id}", payload
+        )
+
+    def delete_line_items(self, document_id):
+        """
+        Delete all line items on an existing document.
+        https://docs.veryfi.com/api/receipts-invoices/delete-all-document-line-items/
+
+        :param document_id: ID of the document you'd like to delete
+        """
+        self.client._request("DELETE", f"/documents/{document_id}/line-items/")
+
+    def delete_line_item(self, document_id, line_item_id):
+        """
+        Delete an existing line item on an existing document.
+        https://docs.veryfi.com/api/receipts-invoices/delete-a-line-item/
+
+        :param document_id: ID of the document you'd like to delete
+        :param line_item_id: ID of the line item you'd like to delete
+        """
+        self.client._request("DELETE", f"/documents/{document_id}/line-items/{line_item_id}")

veryfi/_documents/line_items.py

@@ -0,0 +1,88 @@
+import os
+import base64
+from typing import *
+
+from veryfi.client_base import Client
+
+
+class PDFSplit:
+    def __init__(self, client: Client):
+        self.client = client
+
+    def get_pdf(self, **kwargs):
+        """
+        Get a Submitted PDF endpoint allows you to retrieve a collection of previously processed.
+        https://docs.veryfi.com/api/receipts-invoices/get-submitted-pdf/
+
+        :param kwargs: Additional query parameters.
+        :return: The processed Document response.
+        """
+        endpoint_name = "/documents-set/"
+        return self.client._request("GET", endpoint_name, {}, kwargs)
+
+    def get_documents_from_pdf(self, document_id: int):
+        """
+        Get Documents from PDF endpoint allows you to retrieve a collection of previously processed documents.
+        https://docs.veryfi.com/api/receipts-invoices/get-documents-from-pdf/
+        :param document_id: ID of the document you'd like to retrieve
+        :return: The processed Document response.
+        """
+        endpoint_name = f"/documents-set/{document_id}"
+        return self.client._request("GET", endpoint_name, {})
+
+    def split_and_process_pdf(
+        self,
+        file_path: str,
+        categories: Optional[List] = None,
+        **kwargs,
+    ) -> Dict:
+        """
+        Process a document and extract all the fields from it
+        https://docs.veryfi.com/api/receipts-invoices/split-and-process-a-pdf/
+
+        :param file_path: Path on disk to a file to submit for data extraction
+        :param categories: List of categories Veryfi can use to categorize the document
+        :param kwargs: Additional body parameters
+        :return: Data extracted from the document
+        """
+        endpoint_name = "/documents-set/"
+        categories = categories or []
+        file_name = os.path.basename(file_path)
+        with open(file_path, "rb") as image_file:
+            base64_encoded_string = base64.b64encode(image_file.read()).decode("utf-8")
+        request_arguments = {
+            "file_name": file_name,
+            "file_data": base64_encoded_string,
+            "categories": categories,
+        }
+        request_arguments.update(kwargs)
+        return self.client._request("POST", endpoint_name, request_arguments)
+
+    def split_and_process_pdf_url(
+        self,
+        file_url: Optional[str] = None,
+        categories: Optional[List[str]] = None,
+        max_pages_to_process: Optional[int] = None,
+        file_urls: Optional[List[str]] = None,
+        **kwargs,
+    ) -> Dict:
+        """Process Document from url and extract all the fields from it.
+        https://docs.veryfi.com/api/receipts-invoices/split-and-process-a-pdf/
+
+        :param file_url: Required if file_urls isn't specified. Publicly accessible URL to a file, e.g. "https://cdn.example.com/receipt.jpg".
+        :param file_urls: Required if file_url isn't specifies. List of publicly accessible URLs to multiple files, e.g. ["https://cdn.example.com/receipt1.jpg", "https://cdn.example.com/receipt2.jpg"]
+        :param categories: List of categories to use when categorizing the document
+        :param 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 kwargs: Additional body parameters
+        :return: Data extracted from the document.
+        """
+        endpoint_name = "/documents-set/"
+        categories = categories or []
+        request_arguments = {
+            "categories": categories,
+            "file_url": file_url,
+            "file_urls": file_urls,
+            "max_pages_to_process": max_pages_to_process,
+        }
+        request_arguments.update(kwargs)
+        return self.client._request("POST", endpoint_name, request_arguments)

veryfi/_documents/pdf_split.py

@@ -0,0 +1,78 @@
+from typing import *
+from veryfi.client_base import Client
+
+
+class Tags:
+    def __init__(self, client: Client):
+        self.client = client
+
+    def get_tags(self, document_id):
+        """
+        Return all Tag assigned to a specific Document.
+        https://docs.veryfi.com/api/receipts-invoices/get-document-tags/
+
+        :param document_id: ID of the document you'd like to get
+        :return: Added tags data
+        """
+        endpoint_name = f"/documents/{document_id}/tags"
+        return self.client._request("GET", endpoint_name, {})
+
+    def add_tag(self, document_id, tag_name):
+        """
+        Add a new tag on an existing document.
+        https://docs.veryfi.com/api/receipts-invoices/add-a-tag-to-a-document/
+
+        :param document_id: ID of the document you'd like to update
+        :param tag_name: name of the new tag
+        :return: Added tag data
+        """
+        endpoint_name = f"/documents/{document_id}/tags/"
+        request_arguments = {"name": tag_name}
+        return self.client._request("PUT", endpoint_name, request_arguments)
+
+    def replace_tags(self, document_id, tags):
+        """
+        Replace multiple tags on an existing document.
+        https://docs.veryfi.com/api/receipts-invoices/update-a-document/
+
+        :param document_id: ID of the document you'd like to update
+        :param tags: array of strings
+        :return: Added tags data
+        """
+        endpoint_name = f"/documents/{document_id}/"
+        request_arguments = {"tags": tags}
+        return self.client._request("PUT", endpoint_name, request_arguments)
+
+    def add_tags(self, document_id, tags):
+        """
+        Add multiple tags on an existing document.
+        https://docs.veryfi.com/api/receipts-invoices/add-tags-to-a-document/
+
+        :param document_id: ID of the document you'd like to update
+        :param tags: array of strings
+        :return: Added tags data
+        """
+        endpoint_name = f"/documents/{document_id}/tags/"
+        request_arguments = {"tags": tags}
+        return self.client._request("POST", endpoint_name, request_arguments)
+
+    def delete_tag(self, document_id, tag_id):
+        """
+        Unlink a tag from the list of tags assigned to a specific Document.
+        https://docs.veryfi.com/api/receipts-invoices/unlink-a-tag-from-a-document/
+
+        :param document_id: ID of the document
+        :param tag_id: ID of the tag you'd like to unlink
+        """
+        endpoint_name = f"/documents/{document_id}/tags/{tag_id}"
+        self.client._request("DELETE", endpoint_name, {})
+
+    def delete_tags(self, document_id):
+        """
+        Unlink all tags assigned to a specific Document.
+        https://docs.veryfi.com/api/receipts-invoices/unlink-all-tags-from-a-document/
+
+        :param document_id: ID of the document
+        """
+        endpoint_name = f"/documents/{document_id}/tags"
+        self.client._request("DELETE", endpoint_name, {})

veryfi/_documents/tags.py

@@ -0,0 +1,77 @@
+import os
+import base64
+from typing import *
+
+from veryfi.client_base import Client
+
+
+class W2Split:
+    def __init__(self, client: Client):
+        self.client = client
+
+    def get_documents_from_w2(self, document_id: int) -> Dict:
+        """
+        Veryfi's Get Documents from W-2 endpoint allows you to retrieve a collection of previously processed W-2s.
+        https://docs.veryfi.com/api/get-documents-from-w-2/
+
+        :param document_id: The unique identifier of the document.
+        :return: Document Response
+        """
+        endpoint_name = f"/w2s-set/{document_id}/"
+        return self.client._request("GET", endpoint_name, {})
+
+    def get_list_of_w2s(self, **kwargs) -> Dict:
+        """
+        Veryfi's Get List of W-2s endpoint allows you to retrieve a collection of previously processed W-2s.
+        https://docs.veryfi.com/api/get-list-of-documents-from-w-2/
+
+        :param kwargs: Query parameters
+        :return: List of W-2s
+        """
+        endpoint_name = "/w2s-set/"
+        return self.client._request("GET", endpoint_name, {}, kwargs)
+
+    def split_and_process_w2(self, file_path: str, **kwargs) -> Dict:
+        """
+        Process a document and extract all the fields from it
+        https://docs.veryfi.com/api/split-and-process-a-w-2/
+
+        :param file_path: Path on disk to a file to submit for data extraction
+        :param kwargs: Additional body parameters
+        :return: Data extracted from the document
+        """
+        endpoint_name = "/w2s-set/"
+        file_name = os.path.basename(file_path)
+        with open(file_path, "rb") as image_file:
+            base64_encoded_string = base64.b64encode(image_file.read()).decode("utf-8")
+        request_arguments = {
+            "file_name": file_name,
+            "file_data": base64_encoded_string,
+        }
+        request_arguments.update(kwargs)
+        return self.client._request("POST", endpoint_name, request_arguments)
+
+    def split_and_process_w2_url(
+        self,
+        file_url: Optional[str] = None,
+        file_urls: Optional[List[str]] = None,
+        max_pages_to_process: Optional[int] = None,
+        **kwargs,
+    ) -> Dict:
+        """Process Document from url and extract all the fields from it.
+        https://docs.veryfi.com/api/split-and-process-a-w-2/
+
+        :param file_url: Required if file_urls isn't specified. Publicly accessible URL to a file, e.g. "https://cdn.example.com/receipt.jpg".
+        :param file_urls: Required if file_url isn't specifies. List of publicly accessible URLs to multiple files, e.g. ["https://cdn.example.com/receipt1.jpg", "https://cdn.example.com/receipt2.jpg"]
+        :param 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 kwargs: Additional body parameters
+        :return: Data extracted from the document.
+        """
+        endpoint_name = "/w2s-set/"
+        request_arguments = {
+            "file_url": file_url,
+            "file_urls": file_urls,
+            "max_pages_to_process": max_pages_to_process,
+        }
+        request_arguments.update(kwargs)
+        return self.client._request("POST", endpoint_name, request_arguments)