lago-python-client 1.18.0__tar.gz → 1.22.0__tar.gz

{lago_python_client-1.18.0 → lago_python_client-1.22.0}/PKG-INFO

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

{lago_python_client-1.18.0 → lago_python_client-1.22.0}/lago_python_client/client.py

@@ -15,6 +15,7 @@ from .mrrs.clients import MrrClient
 from .organizations.clients import OrganizationClient
 from .overdue_balances.clients import OverdueBalanceClient
 from .payment_requests.clients import PaymentRequestClient
+from .payments.clients import PaymentClient
 from .invoice_collections.clients import InvoiceCollectionClient
 from .plans.clients import PlanClient
 from .subscriptions.clients import SubscriptionClient
@@ -118,6 +119,10 @@ class Client:
     def payment_requests(self) -> PaymentRequestClient:
         return PaymentRequestClient(self.base_api_url, self.api_key)
 
+    @callable_cached_property
+    def payments(self) -> PaymentClient:
+        return PaymentClient(self.base_api_url, self.api_key)
+
     @callable_cached_property
     def invoice_collections(self) -> InvoiceCollectionClient:
         return InvoiceCollectionClient(self.base_api_url, self.api_key)

{lago_python_client-1.18.0 → lago_python_client-1.22.0}/lago_python_client/customers/clients.py

@@ -1,5 +1,5 @@
 import sys
-from typing import Any, Mapping, ClassVar, Type
+from typing import Any, Mapping, ClassVar, Type, Optional
 
 from ..base_client import BaseClient
 from ..mixins import (
@@ -35,14 +35,18 @@ class CustomerClient(
     RESPONSE_MODEL: ClassVar[Type[CustomerResponse]] = CustomerResponse
     ROOT_NAME: ClassVar[str] = "customer"
 
-    def current_usage(self, resource_id: str, external_subscription_id: str) -> CustomerUsageResponse:
+    def current_usage(
+        self, resource_id: str, external_subscription_id: str, apply_taxes: Optional[str] = None
+    ) -> CustomerUsageResponse:
+        query_params = {"external_subscription_id": external_subscription_id}
+        if apply_taxes is not None:
+            query_params["apply_taxes"] = apply_taxes
+
         api_response: Response = send_get_request(
             url=make_url(
                 origin=self.base_url,
                 path_parts=(self.API_RESOURCE, resource_id, "current_usage"),
-                query_pairs={
-                    "external_subscription_id": external_subscription_id,
-                },
+                query_pairs=query_params,
             ),
             headers=make_headers(api_key=self.api_key),
         )

{lago_python_client-1.18.0 → lago_python_client-1.22.0}/lago_python_client/invoices/clients.py

@@ -7,7 +7,8 @@ from ..mixins import (
     UpdateCommandMixin,
     CreateCommandMixin,
 )
-from ..models.invoice import InvoiceResponse
+from ..models.invoice import InvoicePreview, InvoiceResponse
+from ..services.json import to_json
 from ..services.request import (
     make_headers,
     make_url,
@@ -131,3 +132,18 @@ class InvoiceClient(
 
         response_data = get_response_data(response=api_response, key="invoice_payment_details")
         return response_data.get("payment_url", "") if isinstance(response_data, Mapping) else ""
+
+    def preview(self, input_object: InvoicePreview) -> InvoiceResponse:
+        api_response: Response = send_post_request(
+            url=make_url(
+                origin=self.base_url,
+                path_parts=(self.API_RESOURCE, "preview"),
+            ),
+            content=to_json(input_object.dict()),
+            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.18.0 → lago_python_client-1.22.0}/lago_python_client/models/__init__.py

@@ -7,6 +7,10 @@ from .billable_metric import (
     BillableMetricEvaluateExpression as BillableMetricEvaluateExpression,
     BillableMetricEvaluateExpressionResponse as BillableMetricEvaluateExpressionResponse,
 )
+from .billing_period import (
+    BillingPeriodResponse as BillingPeriodResponse,
+    BillingPeriodsResponse as BillingPeriodsResponse,
+)
 from .charge import (
     Charge as Charge,
     Charges as Charges,
@@ -14,7 +18,7 @@ from .charge import (
     ChargeFilters as ChargeFilters,
     ChargeFilter as ChargeFilter,
 )
-from .coupon import Coupon as Coupon, LimitationConfiguration as LimitationConfiguration
+from .coupon import Coupon as Coupon, CouponsList as CouponsList, LimitationConfiguration as LimitationConfiguration
 from .credit import CreditResponse as CreditResponse, CreditsResponse as CreditsResponse
 from .credit_note import (
     Item as Item,
@@ -50,6 +54,7 @@ from .invoice import (
     InvoiceMetadata as InvoiceMetadata,
     InvoiceMetadataList as InvoiceMetadataList,
     OneOffInvoice as OneOffInvoice,
+    InvoicePreview as InvoicePreview,
     InvoiceFeesList as InvoiceFeesList,
     InvoiceFee as InvoiceFee,
 )
@@ -86,4 +91,5 @@ from .usage_threshold import (
     UsageThresholdsResponse as UsageThresholdsResponse,
 )
 from .payment_request import PaymentRequest as PaymentRequest
+from .payment import Payment as Payment
 from .lifetime_usage import LifetimeUsageResponse as LifetimeUsageResponse

lago_python_client-1.22.0/lago_python_client/models/billing_period.py

@@ -0,0 +1,18 @@
+from typing import List
+
+from lago_python_client.base_model import BaseResponseModel
+
+
+class BillingPeriodResponse(BaseResponseModel):
+    lago_subscription_id: str
+    external_subscription_id: str
+    lago_plan_id: str
+    subscription_from_datetime: str
+    subscription_to_datetime: str
+    charges_from_datetime: str
+    charges_to_datetime: str
+    invoicing_reason: str
+
+
+class BillingPeriodsResponse(BaseResponseModel):
+    __root__: List[BillingPeriodResponse]

{lago_python_client-1.18.0 → lago_python_client-1.22.0}/lago_python_client/models/coupon.py

@@ -46,3 +46,7 @@ class CouponResponse(BaseResponseModel):
     limited_plans: Optional[bool]
     billable_metric_codes: Optional[List[Any]]
     limited_billable_metrics: Optional[bool]
+
+
+class CouponsList(BaseModel):
+    __root__: List[Coupon]

{lago_python_client-1.18.0 → lago_python_client-1.22.0}/lago_python_client/models/invoice.py

@@ -2,10 +2,12 @@ from typing import List, Optional
 
 from lago_python_client.base_model import BaseModel
 
+from .billing_period import BillingPeriodsResponse
+from .coupon import CouponsList
 from .credit import CreditsResponse
-from .customer import CustomerResponse
+from .customer import Customer, CustomerResponse
 from .fee import FeesResponse
-from .subscription import SubscriptionsResponse
+from .subscription import Subscriptions, SubscriptionsResponse
 from .error_detail import ErrorDetailsResponse
 from ..base_model import BaseResponseModel
 from .usage_threshold import UsageThreshold
@@ -51,6 +53,15 @@ class OneOffInvoice(BaseModel):
     error_details: Optional[ErrorDetailsResponse]
 
 
+class InvoicePreview(BaseModel):
+    plan_code: Optional[str]
+    billing_time: Optional[str]
+    subscription_at: Optional[str]
+    coupons: Optional[CouponsList]
+    customer: Optional[Customer]
+    subscriptions: Optional[Subscriptions]
+
+
 class InvoiceAppliedTax(BaseResponseModel):
     lago_id: Optional[str]
     lago_invoice_id: Optional[str]
@@ -114,10 +125,12 @@ class InvoiceResponse(BaseResponseModel):
     sub_total_excluding_taxes_amount_cents: int
     sub_total_including_taxes_amount_cents: int
     total_amount_cents: int
+    total_due_amount_cents: int
     prepaid_credit_amount_cents: int
 
     file_url: Optional[str]
     customer: Optional[CustomerResponse]
+    billing_periods: Optional[BillingPeriodsResponse]
     subscriptions: Optional[SubscriptionsResponse]
     fees: Optional[FeesResponse]
     credits: Optional[CreditsResponse]

lago_python_client-1.22.0/lago_python_client/models/payment.py

@@ -0,0 +1,26 @@
+from typing import List, Optional
+
+from ..base_model import BaseModel, BaseResponseModel
+
+
+class Payment(BaseModel):
+    invoice_id: str
+    amount_cents: int
+    reference: str
+    paid_at: Optional[str]
+
+
+class PaymentResponse(BaseResponseModel):
+    lago_id: str
+    invoice_ids: List[str]
+    amount_cents: int
+    amount_currency: str
+    payment_status: str
+    type: str
+    reference: str
+    external_payment_id: Optional[str]
+    created_at: str
+
+
+class PaymentsResponse(BaseResponseModel):
+    __root__: List[PaymentResponse]

{lago_python_client-1.18.0 → lago_python_client-1.22.0}/lago_python_client/models/subscription.py

@@ -16,6 +16,10 @@ class Subscription(BaseModel):
     plan_overrides: Optional[PlanOverrides]
 
 
+class Subscriptions(BaseModel):
+    external_ids: Optional[List[str]]
+
+
 class SubscriptionResponse(BaseResponseModel):
     lago_id: str
     lago_customer_id: Optional[str]

lago_python_client-1.22.0/lago_python_client/payments/clients.py

@@ -0,0 +1,16 @@
+from typing import ClassVar, Type
+
+from ..base_client import BaseClient
+from ..mixins import CreateCommandMixin, FindAllCommandMixin, FindCommandMixin
+from ..models.payment import PaymentResponse
+
+
+class PaymentClient(
+    CreateCommandMixin[PaymentResponse],
+    FindAllCommandMixin[PaymentResponse],
+    FindCommandMixin[PaymentResponse],
+    BaseClient,
+):
+    API_RESOURCE: ClassVar[str] = "payments"
+    RESPONSE_MODEL: ClassVar[Type[PaymentResponse]] = PaymentResponse
+    ROOT_NAME: ClassVar[str] = "payment"

lago_python_client-1.22.0/lago_python_client/version.py

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

{lago_python_client-1.18.0 → lago_python_client-1.22.0}/lago_python_client.egg-info/PKG-INFO

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

{lago_python_client-1.18.0 → lago_python_client-1.22.0}/lago_python_client.egg-info/SOURCES.txt

@@ -37,6 +37,7 @@ setup.cfg
 ./lago_python_client/models/add_on.py
 ./lago_python_client/models/applied_coupon.py
 ./lago_python_client/models/billable_metric.py
+./lago_python_client/models/billing_period.py
 ./lago_python_client/models/charge.py
 ./lago_python_client/models/coupon.py
 ./lago_python_client/models/credit.py
@@ -56,6 +57,7 @@ setup.cfg
 ./lago_python_client/models/mrr.py
 ./lago_python_client/models/organization.py
 ./lago_python_client/models/overdue_balance.py
+./lago_python_client/models/payment.py
 ./lago_python_client/models/payment_request.py
 ./lago_python_client/models/plan.py
 ./lago_python_client/models/subscription.py
@@ -72,6 +74,8 @@ setup.cfg
 ./lago_python_client/overdue_balances/clients.py
 ./lago_python_client/payment_requests/__init__.py
 ./lago_python_client/payment_requests/clients.py
+./lago_python_client/payments/__init__.py
+./lago_python_client/payments/clients.py
 ./lago_python_client/plans/__init__.py
 ./lago_python_client/plans/clients.py
 ./lago_python_client/services/__init__.py
@@ -107,6 +111,7 @@ setup.cfg
 ./tests/test_mrr_client.py
 ./tests/test_organization_client.py
 ./tests/test_overdue_balance_client.py
+./tests/test_payment_client.py
 ./tests/test_payment_request_client.py
 ./tests/test_plan_client.py
 ./tests/test_request_services.py
@@ -157,6 +162,7 @@ lago_python_client/models/__init__.py
 lago_python_client/models/add_on.py
 lago_python_client/models/applied_coupon.py
 lago_python_client/models/billable_metric.py
+lago_python_client/models/billing_period.py
 lago_python_client/models/charge.py
 lago_python_client/models/coupon.py
 lago_python_client/models/credit.py
@@ -176,6 +182,7 @@ lago_python_client/models/minimum_commitment.py
 lago_python_client/models/mrr.py
 lago_python_client/models/organization.py
 lago_python_client/models/overdue_balance.py
+lago_python_client/models/payment.py
 lago_python_client/models/payment_request.py
 lago_python_client/models/plan.py
 lago_python_client/models/subscription.py
@@ -192,6 +199,8 @@ lago_python_client/overdue_balances/__init__.py
 lago_python_client/overdue_balances/clients.py
 lago_python_client/payment_requests/__init__.py
 lago_python_client/payment_requests/clients.py
+lago_python_client/payments/__init__.py
+lago_python_client/payments/clients.py
 lago_python_client/plans/__init__.py
 lago_python_client/plans/clients.py
 lago_python_client/services/__init__.py
@@ -227,6 +236,7 @@ tests/test_json_services.py
 tests/test_mrr_client.py
 tests/test_organization_client.py
 tests/test_overdue_balance_client.py
+tests/test_payment_client.py
 tests/test_payment_request_client.py
 tests/test_plan_client.py
 tests/test_request_services.py

{lago_python_client-1.18.0 → lago_python_client-1.22.0}/tests/test_customer_client.py

@@ -129,6 +129,23 @@ def test_valid_current_usage(httpx_mock: HTTPXMock):
     assert response.charges_usage[0].filters[0].values["country"] == ["france"]
 
 
+def test_valid_current_usage_without_taxes(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/customers/external_customer_id/current_usage?external_subscription_id=123&apply_taxes=false",
+        content=mock_response("customer_usage"),
+    )
+    response = client.customers.current_usage("external_customer_id", "123", "false")
+
+    assert response.from_datetime == "2022-07-01T00:00:00Z"
+    assert len(response.charges_usage) == 1
+    assert response.charges_usage[0].units == 1.0
+    assert len(response.charges_usage[0].filters) == 1
+    assert response.charges_usage[0].filters[0].values["country"] == ["france"]
+
+
 def test_invalid_current_usage(httpx_mock: HTTPXMock):
     client = Client(api_key="886fe239-927d-4072-ab72-6dd345e8dd0d")
 

{lago_python_client-1.18.0 → lago_python_client-1.22.0}/tests/test_invoice_client.py

@@ -6,7 +6,9 @@ from pytest_httpx import HTTPXMock
 from lago_python_client.client import Client
 from lago_python_client.exceptions import LagoApiError
 from lago_python_client.models import (
+    Customer,
     Invoice,
+    InvoicePreview,
     InvoiceMetadata,
     InvoiceMetadataList,
     OneOffInvoice,
@@ -29,6 +31,12 @@ def one_off_invoice_object():
     return OneOffInvoice(customer_external_id="external", currency="EUR", fees=fees_list)
 
 
+def invoice_preview():
+    customer = Customer(name="John Doe", external_id="test1")
+
+    return InvoicePreview(customer=customer, plan_code="test", billing_time="anniversary", subscription_at="2025-01-24")
+
+
 def mock_response(mock="invoice"):
     this_dir = os.path.dirname(os.path.abspath(__file__))
     my_data_path = os.path.join(this_dir, "fixtures/" + mock + ".json")
@@ -268,3 +276,18 @@ def test_valid_payment_url_request(httpx_mock: HTTPXMock):
     response = client.invoices.payment_url("5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba")
 
     assert response == "https://checkout.stripe.com/c/pay/cs_test_a1cuqFkXvH"
+
+
+def test_valid_preview_request(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/preview",
+        content=mock_response(),
+    )
+    response = client.invoices.preview(invoice_preview())
+
+    assert response.lago_id == "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
+    assert response.status == "finalized"
+    assert response.payment_status == "failed"

lago_python_client-1.22.0/tests/test_payment_client.py

@@ -0,0 +1,108 @@
+import os
+
+import pytest
+from pytest_httpx import HTTPXMock
+
+from lago_python_client.client import Client
+from lago_python_client.exceptions import LagoApiError
+from lago_python_client.models import Payment
+
+
+def payment_object():
+    return Payment(
+        amount_cents=100,
+        reference="ref1",
+        invoice_id="f8e194df-5d90-4382-b146-c881d2c67f28",
+        paid_at="2025-01-01T13:00:00Z",
+    )
+
+
+def mock_response():
+    this_dir = os.path.dirname(os.path.abspath(__file__))
+    data_path = os.path.join(this_dir, "fixtures/payment.json")
+
+    with open(data_path, "rb") as payment_response:
+        return payment_response.read()
+
+
+def mock_collection_response():
+    current_dir = os.path.dirname(os.path.abspath(__file__))
+    data_path = os.path.join(current_dir, "fixtures/payment_index.json")
+
+    with open(data_path, "rb") as payments_response:
+        return payments_response.read()
+
+
+def test_valid_find_all_payments_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/payments",
+        content=mock_collection_response(),
+    )
+    response = client.payments.find_all()
+
+    assert response["payments"][0].lago_id == "8e5d5ec2-bdc7-4c43-a944-5ababae775d4"
+    assert response["meta"]["current_page"] == 1
+
+
+def test_valid_find_all_payments_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/payments?per_page=2&page=1",
+        content=mock_collection_response(),
+    )
+    response = client.payments.find_all({"per_page": 2, "page": 1})
+
+    assert response["payments"][0].lago_id == "8e5d5ec2-bdc7-4c43-a944-5ababae775d4"
+    assert response["meta"]["current_page"] == 1
+
+
+def test_invalid_find_all_payment_request(httpx_mock: HTTPXMock):
+    client = Client(api_key="invalid")
+
+    httpx_mock.add_response(
+        method="GET",
+        url="https://api.getlago.com/api/v1/payments",
+        status_code=404,
+        content=b"",
+    )
+
+    with pytest.raises(LagoApiError):
+        client.payments.find_all()
+
+
+def test_valid_create_payment_request(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/payments",
+        content=mock_response(),
+    )
+    response = client.payments.create(payment_object())
+
+    assert response is not None
+    assert response.lago_id == "8e5d5ec2-bdc7-4c43-a944-5ababae775d4"
+    assert response.amount_cents == 100
+    assert response.amount_currency == "USD"
+    assert response.payment_status == "succeeded"
+    assert len(response.invoice_ids) == 1
+    assert response.invoice_ids[0] == "f8e194df-5d90-4382-b146-c881d2c67f28"
+
+
+def test_invalid_create_payment_request(httpx_mock: HTTPXMock):
+    client = Client(api_key="invalid")
+
+    httpx_mock.add_response(
+        method="POST",
+        url="https://api.getlago.com/api/v1/payments",
+        status_code=401,
+        content=b"",
+    )
+
+    with pytest.raises(LagoApiError):
+        client.payments.create(payment_object())

lago_python_client-1.18.0/lago_python_client/version.py

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