feat(payment-receipts): Add payment receipts (#304)

Author: ivannovosad

lago_python_client/client.py

@@ -14,6 +14,7 @@
 from .mrrs.clients import MrrClient
 from .organizations.clients import OrganizationClient
 from .overdue_balances.clients import OverdueBalanceClient
+from .payment_receipts.clients import PaymentReceiptClient
 from .payment_requests.clients import PaymentRequestClient
 from .payments.clients import PaymentClient
 from .invoice_collections.clients import InvoiceCollectionClient
@@ -115,6 +116,10 @@ def organizations(self) -> OrganizationClient:
     def overdue_balances(self) -> OverdueBalanceClient:
         return OverdueBalanceClient(self.base_api_url, self.api_key)
 
+    @callable_cached_property
+    def payment_receipts(self) -> PaymentReceiptClient:
+        return PaymentReceiptClient(self.base_api_url, self.api_key)
+
     @callable_cached_property
     def payment_requests(self) -> PaymentRequestClient:
         return PaymentRequestClient(self.base_api_url, self.api_key)

lago_python_client/models/__init__.py

@@ -90,6 +90,10 @@
     UsageThresholds as UsageThresholds,
     UsageThresholdsResponse as UsageThresholdsResponse,
 )
+from .payment_receipt import (
+    PaymentReceiptResponse as PaymentReceiptResponse,
+    PaymentReceiptsResponse as PaymentReceiptsResponse,
+)
 from .payment_request import PaymentRequest as PaymentRequest
 from .payment import Payment as Payment
 from .lifetime_usage import LifetimeUsageResponse as LifetimeUsageResponse

lago_python_client/models/payment_receipt.py

@@ -0,0 +1,15 @@
+from typing import List
+
+from ..base_model import BaseResponseModel
+from .payment import PaymentResponse
+
+
+class PaymentReceiptResponse(BaseResponseModel):
+    lago_id: str
+    number: str
+    payment: PaymentResponse
+    created_at: str
+
+
+class PaymentReceiptsResponse(BaseResponseModel):
+    __root__: List[PaymentReceiptResponse]

lago_python_client/payment_receipts/__init__.py

@@ -0,0 +1,15 @@
+from typing import ClassVar, Type
+
+from ..base_client import BaseClient
+from ..mixins import FindAllCommandMixin, FindCommandMixin
+from ..models.payment_receipt import PaymentReceiptResponse
+
+
+class PaymentReceiptClient(
+    FindAllCommandMixin[PaymentReceiptResponse],
+    FindCommandMixin[PaymentReceiptResponse],
+    BaseClient,
+):
+    API_RESOURCE: ClassVar[str] = "payment_receipts"
+    RESPONSE_MODEL: ClassVar[Type[PaymentReceiptResponse]] = PaymentReceiptResponse
+    ROOT_NAME: ClassVar[str] = "payment_receipt"

lago_python_client/payment_receipts/clients.py

@@ -0,0 +1,20 @@
+{
+  "payment_receipt": {
+    "lago_id": "89b6b61e-4dbc-4307-ac96-4abcfa9e3e2d",
+    "number": "LAG-1234-001-002",
+    "created_at": "2024-06-30T10:59:51Z",
+    "payment": {
+      "lago_id": "8e5d5ec2-bdc7-4c43-a944-5ababae775d4",
+      "invoice_ids": [
+          "ed267c66-8170-4d23-83e8-6d6e4fc735ef"
+      ],
+      "amount_cents": 100,
+      "amount_currency": "USD",
+      "payment_status": "succeeded",
+      "type": "manual",
+      "reference": "the reference",
+      "external_payment_id": null,
+      "created_at": "2025-02-18T18:31:13Z"
+    }
+  }
+}

tests/fixtures/payment_receipt.json

@@ -0,0 +1,25 @@
+{
+  "payment_receipts": [
+    {
+      "lago_id": "89b6b61e-4dbc-4307-ac96-4abcfa9e3e2d",
+      "number": "LAG-1234-001-002",
+      "created_at": "2024-06-30T10:59:51Z",
+      "payment": {
+        "lago_id": "8e5d5ec2-bdc7-4c43-a944-5ababae775d4",
+        "invoice_ids": [
+            "ed267c66-8170-4d23-83e8-6d6e4fc735ef"
+        ],
+        "amount_cents": 100,
+        "amount_currency": "USD",
+        "payment_status": "succeeded",
+        "type": "manual",
+        "reference": "the reference",
+        "external_payment_id": null,
+        "created_at": "2025-02-18T18:31:13Z"
+      }
+    }
+  ],
+  "meta": {
+    "current_page": 1
+  }
+}

tests/fixtures/payment_receipt_index.json

@@ -0,0 +1,65 @@
+import os
+
+import pytest
+from pytest_httpx import HTTPXMock
+
+from lago_python_client.client import Client
+from lago_python_client.exceptions import LagoApiError
+
+
+def mock_response():
+    this_dir = os.path.dirname(os.path.abspath(__file__))
+    data_path = os.path.join(this_dir, "fixtures/payment_receipt.json")
+
+    with open(data_path, "rb") as payment_receipt_response:
+        return payment_receipt_response.read()
+
+
+def mock_collection_response():
+    current_dir = os.path.dirname(os.path.abspath(__file__))
+    data_path = os.path.join(current_dir, "fixtures/payment_receipt_index.json")
+
+    with open(data_path, "rb") as payment_receipts_response:
+        return payment_receipts_response.read()
+
+
+def test_valid_find_all_payment_receipts_request(httpx_mock: HTTPXMock):
+    client = Client(api_key="886fe239-927d-4072-ab72-6dd345e8dd0d")
+
+    httpx_mock.add_response(
+        method="GET",
+        url="https://api.getlago.com/api/v1/payment_receipts",
+        content=mock_collection_response(),
+    )
+    response = client.payment_receipts.find_all()
+
+    assert response["payment_receipts"][0].lago_id == "89b6b61e-4dbc-4307-ac96-4abcfa9e3e2d"
+    assert response["meta"]["current_page"] == 1
+
+
+def test_valid_find_all_payment_receipts_request_with_options(httpx_mock: HTTPXMock):
+    client = Client(api_key="886fe239-927d-4072-ab72-6dd345e8dd0d")
+
+    httpx_mock.add_response(
+        method="GET",
+        url="https://api.getlago.com/api/v1/payment_receipts?per_page=2&page=1",
+        content=mock_collection_response(),
+    )
+    response = client.payment_receipts.find_all({"per_page": 2, "page": 1})
+
+    assert response["payment_receipts"][0].lago_id == "89b6b61e-4dbc-4307-ac96-4abcfa9e3e2d"
+    assert response["meta"]["current_page"] == 1
+
+
+def test_invalid_find_all_payment_receipts_request(httpx_mock: HTTPXMock):
+    client = Client(api_key="invalid")
+
+    httpx_mock.add_response(
+        method="GET",
+        url="https://api.getlago.com/api/v1/payment_receipts",
+        status_code=404,
+        content=b"",
+    )
+
+    with pytest.raises(LagoApiError):
+        client.payment_receipts.find_all()