Merge pull request #35 from veryfi/get_documents-add_params

Get documents add params

Author: manycoding

.github/workflows/release-pypi.yml

@@ -6,7 +6,7 @@ on:
 
 jobs:
   build:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04
     strategy:
       matrix:
         python-version: [3.6]

.github/workflows/test.yml

@@ -7,7 +7,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [3.6, 3.7, 3.8, 3.9]
+        python-version: [3.7, 3.8, 3.9]
     steps:
       - uses: actions/checkout@v2
       - name: Set up Python ${{ matrix.python-version }}

tests/test_client.py

@@ -270,3 +270,100 @@ def test_process_w9_document():
     )
     d = client.process_w9_document(file_path="tests/assets/receipt_public.jpg")
     assert d == mock
+
+
+@responses.activate
+def test_get_documents():
+    mock = [
+        {
+            "abn_number": "",
+            "account_number": "",
+            "barcodes": [],
+            "bill_to_address": "",
+            "bill_to_name": "",
+            "bill_to_vat_number": "",
+            "card_number": "",
+            "cashback": 0.0,
+            "category": "",
+            "created": "2021-06-22 20:31:04",
+            "currency_code": "USD",
+            "date": "2021-06-22 16:31:04",
+            "discount": 0.0,
+            "due_date": "",
+            "external_id": "",
+            "id": 36967602,
+            "img_file_name": "962748f4-95bb-400b-9f59-9c2d5e42e6af.jpg",
+            "img_thumbnail_url": "",
+            "img_url": "",
+            "invoice_number": "98",
+            "line_items": [
+                {
+                    "date": "",
+                    "description": "98 Meat Pty Xchz",
+                    "discount": 0.0,
+                    "id": 67188771,
+                    "order": 0,
+                    "price": 0.0,
+                    "quantity": 1.0,
+                    "reference": "",
+                    "sku": "",
+                    "tax": 0.0,
+                    "tax_rate": 0.0,
+                    "total": 90.85,
+                    "type": "food",
+                    "unit_of_measure": "",
+                }
+            ],
+            "notes": "",
+            "ocr_text": "\n\x0c2004-10-31\n\t8:21 PM\nYOUR GUEST NUMBER IS\n98\nIN-N-OUT BURGER LAS VEGAS EASTERN\n2004-10-31\t\t8:21 PM\n165 1 5 98\nCashier: SAM\nGUEST #: 98\nCounter-Eat in\n\t2.65\nDbDb\t\t88.20\n98 Meat Pty Xchz\n\t90.85\nCounter-Eat In\t\t6.81\nTAX 7.50%\t\t97.66\nAmount Due\n\t$97.66\nCASH TENDER\t\t$.00\nChange\n2004-10-31\t\t8:21 PM\nTHANK YOU!\n",
+            "payment_display_name": "Cash",
+            "payment_terms": "",
+            "payment_type": "cash",
+            "phone_number": "",
+            "purchase_order_number": "",
+            "reference_number": "VBIJG-7602",
+            "rounding": 0.0,
+            "service_end_date": "",
+            "service_start_date": "",
+            "shipping": 0.0,
+            "subtotal": 0.0,
+            "tags": [],
+            "tax": 97.66,
+            "tax_lines": [{"base": 0.0, "name": "", "order": 0, "rate": 7.5, "total": 97.66}],
+            "tip": 0.0,
+            "total": 97.66,
+            "tracking_number": "",
+            "updated": "2021-06-22 20:31:05",
+            "vat_number": "",
+            "vendor": {
+                "address": "",
+                "email": "",
+                "fax_number": "",
+                "name": "In-N-Out Burger",
+                "phone_number": "",
+                "raw_name": "In-N-Out Burger",
+                "vendor_logo": "https://cdn.veryfi.com/logos/us/949103001.png",
+                "vendor_reg_number": "",
+                "vendor_type": "Restaurant",
+                "web": "",
+            },
+            "vendor_account_number": "",
+            "vendor_bank_name": "",
+            "vendor_bank_number": "",
+            "vendor_bank_swift": "",
+            "vendor_iban": "",
+        }
+    ]
+    client = Client(client_id="v", client_secret="w", username="o", api_key="c")
+    responses.add(
+        responses.GET,
+        f"{client.versioned_url}/partner/documents/",
+        json=mock,
+        status=200,
+    )
+    d = client.get_documents(
+        q="In-N-Out Burger",
+        created_gte="2021-05-22+00:00:00",
+        **{"created_lt": "2021-07-22+00:00:00"},
+    )
+    assert d == mock

veryfi/client.py

@@ -123,14 +123,52 @@ def _generate_signature(self, payload_params, timestamp):
         base64_signature = base64.b64encode(tmp_signature).decode("utf-8").strip()
         return base64_signature
 
-    def get_documents(self):
+    def get_documents(
+        self,
+        q: Optional[str] = None,
+        external_id: Optional[str] = None,
+        tag: Optional[str] = None,
+        created_gt: Optional[str] = None,
+        created_gte: Optional[str] = None,
+        created_lt: Optional[str] = None,
+        created_lte: Optional[str] = None,
+        **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
         :return: List of previously processed documents
         """
         endpoint_name = "/documents/"
-        request_arguments = {}
-        documents = self._request("GET", endpoint_name, request_arguments)
+
+        request_params = {}
+        if q:
+            request_params["q"] = q
+        if external_id:
+            request_params["external_id"] = external_id
+        if tag:
+            request_params["tag"] = tag
+        if created_gt:
+            request_params["created__gt"] = created_gt
+        if created_gte:
+            request_params["created__gte"] = created_gte
+        if created_lt:
+            request_params["created__lt"] = created_lt
+        if created_lte:
+            request_params["created__lte"] = created_lte
+        request_params.update(kwargs)
+        if request_params:
+            endpoint_name += "?" + "&".join(f"{k}={v}" for k, v in request_params.items())
+
+        documents = self._request("GET", endpoint_name, {})
+
         if "documents" in documents:
             return documents["documents"]
         return documents