Disallow v7 api, remove models and update docs

Valeriy Mukhtarulin · Valeriy Mukhtarulin · commit 8f72083cc2cc · 2024-08-15T11:47:54.000-04:00
diff --git a/requirements.txt b/requirements.txt
@@ -1,2 +1 @@
 requests>=2.22.0
-pydantic>=1
diff --git a/veryfi/client.py b/veryfi/client.py
@@ -8,7 +8,6 @@
 
 import requests
 
-from veryfi.model import AddLineItem, UpdateLineItem
 from veryfi.errors import VeryfiClientError
 
 
@@ -41,15 +40,14 @@ def __init__(
         username,
         api_key,
         base_url=BASE_URL,
-        api_version=API_VERSION,
         timeout=API_TIMEOUT,
     ):
         self.client_id = client_id
         self.client_secret = client_secret
         self.username = username
         self.api_key = api_key
         self.base_url = base_url
-        self.api_version = api_version
+        self.api_version = "v8"
         self.versioned_url = self.base_url + self.api_version
         self.timeout = timeout
         self.headers = {}
@@ -66,12 +64,11 @@ def _get_headers(self) -> Dict:
             "Content-Type": "application/json",
             "Client-Id": self.client_id,
         }
-
         final_headers.update({"Authorization": f"apikey {self.username}:{self.api_key}"})
 
         return final_headers
 
-    def _request(self, http_verb, endpoint_name, request_arguments):
+    def _request(self, http_verb, endpoint_name, request_arguments=None):
         """
         Submit the HTTP request.
         :param http_verb: HTTP Method
@@ -80,8 +77,8 @@ def _request(self, http_verb, endpoint_name, request_arguments):
         :return: A JSON of the response data.
         """
         headers = self._get_headers()
-        api_url = "{0}/partner{1}".format(self.versioned_url, endpoint_name)
-
+        api_url = f"{self.versioned_url}/partner{endpoint_name}"
+        request_arguments = request_arguments or {}
         if self.client_secret:
             timestamp = int(time.time() * 1000)
             signature = self._generate_signature(request_arguments, timestamp=timestamp)
@@ -112,10 +109,10 @@ def _generate_signature(self, payload_params, timestamp):
         :param timestamp: Unix Long timestamp
         :return: Unique signature generated using the client_secret and the payload
         """
-        payload = "timestamp:{}".format(timestamp)
+        payload = f"timestamp:{timestamp}"
         for key in payload_params.keys():
             value = payload_params[key]
-            payload = "{0},{1}:{2}".format(payload, key, value)
+            payload = f"{payload},{key}:{value}"
 
         secret_bytes = bytes(self.client_secret, "utf-8")
         payload_bytes = bytes(payload, "utf-8")
@@ -135,15 +132,7 @@ def get_documents(
         **kwargs: Dict,
     ):
         """
-        Get list of documents
-        :param query: Search term to search for a specific document by its content. These fields will be searched: external_id, category, vendor.name, notes, invoice_number, total and ocr_text.
-        :param external_id:	Search for documents that match your custom identifier
-        :param tag:	Search for documents with the specified tag
-        :param created__gt:	Search for documents with a created date greater than this one. Format YYYY-MM-DD+HH:MM:SS. Don't send both created__gt and created__gte in a single request.
-        :param created__gte: Search for documents with a created date greater than or equal to this one. Format YYYY-MM-DD+HH:MM:SS. Don't send both created__gt and created__gte in a single request.
-        :param created__lt:	Search for documents with a created date greater than this one. Format YYYY-MM-DD+HH:MM:SS. Don't send both created__lt and created__lte in a single request.
-        :param created__lte: Search for documents with a created date less than or equal to this one. Format YYYY-MM-DD+HH:MM:SS. Don't send both created__lt and created__lte in a single request.
-        :param kwargs: Additional request parameters
+        Get list of documents. Please refer to https://docs.veryfi.com/api/receipts-invoices/search-documents/
         :return: List of previously processed documents
         """
         endpoint_name = "/documents/"
@@ -173,16 +162,14 @@ def get_documents(
             return documents["documents"]
         return documents
 
-    def get_document(self, document_id):
+    def get_document(self, document_id, **kwargs: Dict):
         """
         Retrieve document by ID
+        https://docs.veryfi.com/api/receipts-invoices/get-a-document/
         :param document_id: ID of the document you'd like to retrieve
         :return: Data extracted from the Document
         """
-        endpoint_name = "/documents/{}/".format(document_id)
-        request_arguments = {"id": document_id}
-        document = self._request("GET", endpoint_name, request_arguments)
-        return document
+        return self._request("GET", f"/documents/{document_id}/", kwargs)
 
     def process_document(
         self,
@@ -192,15 +179,15 @@ def process_document(
         **kwargs: Dict,
     ):
         """
-        Process a document and extract all the fields from it
+        Process a document and extract all the fields from it.
+        https://docs.veryfi.com/api/receipts-invoices/process-a-document/
         :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 delete_after_processing: Delete this document from Veryfi after data has been extracted
         :param kwargs: Additional request parameters
 
         :return: Data extracted from the document
         """
-        endpoint_name = "/documents/"
         if not categories:
             categories = self.CATEGORIES
         file_name = os.path.basename(file_path)
@@ -213,8 +200,7 @@ def process_document(
             "auto_delete": delete_after_processing,
         }
         request_arguments.update(kwargs)
-        document = self._request("POST", endpoint_name, request_arguments)
-        return document
+        return self._request("POST", "/documents/", request_arguments)
 
     def process_document_url(
         self,
@@ -228,7 +214,7 @@ def process_document_url(
         **kwargs: Dict,
     ) -> Dict:
         """Process Document from url and extract all the fields from it.
-
+        https://docs.veryfi.com/api/receipts-invoices/process-a-document/
         :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
@@ -254,10 +240,11 @@ def process_document_url(
         return self._request("POST", endpoint_name, request_arguments)
 
     def process_w9_document_url(
-        self, file_url: str, file_name: Optional[str] = None, **kwargs: Dict
+        self, file_url: str, file_name: Optional[str] = None, **kwargs
     ) -> Dict:
         """
         Process W9 Document from url and extract all the fields from it.
+        https://docs.veryfi.com/api/w9s/process-a-w-9/
 
         :param file_url: Publicly accessible URL to a file, e.g. "https://cdn.example.com/receipt.jpg".
         :param file_name: Optional name of file, eg. receipt.jpg
@@ -278,6 +265,7 @@ def process_w9_document_url(
     def process_w9_document(self, file_path: str, file_name: Optional[str] = None, **kwargs):
         """
         Process W9 Document from url and extract all the fields from it.
+        https://docs.veryfi.com/api/w9s/process-a-w-9/
 
         :param file_path: Path on disk to a file to submit for data extraction
         :param file_name: Optional name of file, eg. receipt.jpg
@@ -301,15 +289,15 @@ def process_w9_document(self, file_path: str, file_name: Optional[str] = None, *
     def delete_document(self, document_id):
         """
         Delete Document from Veryfi
+        https://docs.veryfi.com/api/receipts-invoices/delete-a-document/
         :param document_id: ID of the document you'd like to delete
         """
-        endpoint_name = f"/documents/{document_id}/"
-        request_arguments = {"id": document_id}
-        self._request("DELETE", endpoint_name, request_arguments)
+        self._request("DELETE", f"/documents/{document_id}/", {"id": document_id})
 
     def update_document(self, document_id: int, **kwargs) -> Dict:
         """
         Update data for a previously processed document, including almost any field like `vendor`, `date`, `notes` and etc.
+        https://docs.veryfi.com/api/receipts-invoices/update-a-document/
 
         ```veryfi_client.update_document(id, date="2021-01-01", notes="look what I did")```
 
@@ -318,97 +306,86 @@ def update_document(self, document_id: int, **kwargs) -> Dict:
 
         :return: A document json with updated fields, if fields are writable. Otherwise a document with unchanged fields.
         """
-        endpoint_name = f"/documents/{document_id}/"
-
-        return self._request("PUT", endpoint_name, kwargs)
+        return self._request("PUT", f"/documents/{document_id}/", kwargs)
 
     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
         """
-        endpoint_name = f"/documents/{document_id}/line-items/"
-        request_arguments = {}
-        line_items = self._request("GET", endpoint_name, request_arguments)
-        return line_items
+        return self._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
         """
-        endpoint_name = f"/documents/{document_id}/line-items/{line_item_id}"
-        request_arguments = {}
-        line_items = self._request("GET", endpoint_name, request_arguments)
-        return line_items
+        return self._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
         """
-        endpoint_name = f"/documents/{document_id}/line-items/"
-        request_arguments = AddLineItem(**payload).dict(exclude_none=True)
-        return self._request("POST", endpoint_name, request_arguments)
+        return self._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.
         """
-        endpoint_name = f"/documents/{document_id}/line-items/{line_item_id}"
-        request_arguments = UpdateLineItem(**payload).dict(exclude_none=True)
-        return self._request("PUT", endpoint_name, request_arguments)
+        return self._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
         """
-        endpoint_name = f"/documents/{document_id}/line-items/"
-        request_arguments = {}
-        self._request("DELETE", endpoint_name, request_arguments)
+        self._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
         """
-        endpoint_name = f"/documents/{document_id}/line-items/{line_item_id}"
-        request_arguments = {}
-        self._request("DELETE", endpoint_name, request_arguments)
+        self._request("DELETE", f"/documents/{document_id}/line-items/{line_item_id}")
 
     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._request("PUT", endpoint_name, request_arguments)
+        return self._request("PUT", f"/documents/{document_id}/tags/", {"name": tag_name})
 
     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._request("PUT", endpoint_name, request_arguments)
+        return self._request("PUT", f"/documents/{document_id}/", {"tags": tags})
 
     def add_tags(self, document_id, tags):
         """
@@ -417,6 +394,4 @@ def add_tags(self, document_id, tags):
         :param tags: array of strings
         :return: Added tags data
         """
-        endpoint_name = f"/documents/{document_id}/tags/"
-        request_arguments = {"tags": tags}
-        return self._request("POST", endpoint_name, request_arguments)
+        return self._request("POST", f"/documents/{document_id}/tags/", {"tags": tags})
diff --git a/veryfi/model.py b/veryfi/model.py
