lago-python-client 1.30.0__tar.gz → 1.31.0__tar.gz

{lago_python_client-1.30.0 → lago_python_client-1.31.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: lago-python-client
-Version: 1.30.0
+Version: 1.31.0
 Summary: Lago Python API Client
 Home-page: https://github.com/getlago/lago-python-client
 Author: Lovro Colic

{lago_python_client-1.30.0 → lago_python_client-1.31.0}/lago_python_client/invoices/clients.py

@@ -1,4 +1,4 @@
-from typing import ClassVar, Optional, Type, Mapping
+from typing import ClassVar, Optional, Type, Mapping, Any
 
 from ..base_client import BaseClient
 from ..mixins import (
@@ -161,3 +161,18 @@ class InvoiceClient(
             response_model=InvoiceResponse,
             data=get_response_data(response=api_response, key=self.ROOT_NAME),
         )
+
+    def void_invoice(self, resource_id: str, options: Mapping[str, Any] = {}) -> InvoiceResponse:
+        api_response: Response = send_post_request(
+            url=make_url(
+                origin=self.base_url,
+                path_parts=(self.API_RESOURCE, resource_id, "void"),
+            ),
+            content=to_json(options) if options else None,
+            headers=make_headers(api_key=self.api_key),
+        )
+
+        return prepare_object_response(
+            response_model=InvoiceResponse,
+            data=get_response_data(response=api_response, key=self.ROOT_NAME),
+        )

lago_python_client-1.31.0/lago_python_client/version.py

@@ -0,0 +1 @@
+LAGO_VERSION = "1.31.0"

{lago_python_client-1.30.0 → lago_python_client-1.31.0}/lago_python_client.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: lago-python-client
-Version: 1.30.0
+Version: 1.31.0
 Summary: Lago Python API Client
 Home-page: https://github.com/getlago/lago-python-client
 Author: Lovro Colic

{lago_python_client-1.30.0 → lago_python_client-1.31.0}/tests/test_invoice_client.py

@@ -304,3 +304,36 @@ def test_valid_preview_request(httpx_mock: HTTPXMock):
     assert response.lago_id == "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
     assert response.status == "finalized"
     assert response.payment_status == "failed"
+
+
+def test_valid_void_invoice_request_no_options(httpx_mock: HTTPXMock):
+    client = Client(api_key="886fe239-927d-4072-ab72-6dd345e8dd0d")
+
+    httpx_mock.add_response(
+        method="POST",
+        url="https://api.getlago.com/api/v1/invoices/5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba/void",
+        content=mock_response(mock="voided_invoice"),
+    )
+    response = client.invoices.void_invoice("5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba")
+
+    assert response.lago_id == "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
+    assert response.status == "voided"
+
+
+def test_valid_void_invoice_request_with_options(httpx_mock: HTTPXMock):
+    client = Client(api_key="886fe239-927d-4072-ab72-6dd345e8dd0d")
+
+    httpx_mock.add_response(
+        method="POST",
+        url="https://api.getlago.com/api/v1/invoices/5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba/void",
+        content=mock_response(mock="voided_invoice"),
+    )
+    options = {
+        "generate_credit_note": True,
+        "refund_amount": 1000,
+        "credit_amount": 10,
+    }
+    response = client.invoices.void_invoice("5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba", options)
+
+    assert response.lago_id == "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
+    assert response.status == "voided"

lago_python_client-1.30.0/lago_python_client/version.py

@@ -1 +0,0 @@
-LAGO_VERSION = "1.30.0"