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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: lago-python-client
-Version: 1.31.0
+Version: 1.32.0
 Summary: Lago Python API Client
 Home-page: https://github.com/getlago/lago-python-client
 Author: Lovro Colic
@@ -29,6 +29,8 @@ Provides-Extra: test
 Requires-Dist: mypy==0.971; extra == "test"
 Requires-Dist: pytest; extra == "test"
 Requires-Dist: pytest_httpx; extra == "test"
+Provides-Extra: lint
+Requires-Dist: ruff; extra == "lint"
 Dynamic: license-file
 
 # Lago Python Client
@@ -40,10 +42,10 @@ This is a python wrapper for Lago API
 
 ## Current Releases
 
-| Project            | Release Badge                                                                                       |
-|--------------------|-----------------------------------------------------------------------------------------------------|
-| **Lago**           | [![Lago Release](https://img.shields.io/github/v/release/getlago/lago)](https://github.com/getlago/lago/releases) |
-| **Lago Python Client**     | [![Lago Python Client Release](https://img.shields.io/github/v/release/getlago/lago-python-client)](https://github.com/getlago/lago-python-client/releases) |
+| Project                | Release Badge                                                                                                                                               |
+| ---------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **Lago**               | [![Lago Release](https://img.shields.io/github/v/release/getlago/lago)](https://github.com/getlago/lago/releases)                                           |
+| **Lago Python Client** | [![Lago Python Client Release](https://img.shields.io/github/v/release/getlago/lago-python-client)](https://github.com/getlago/lago-python-client/releases) |
 
 ## Installation
 
@@ -65,7 +67,7 @@ Check the [lago API reference](https://doc.getlago.com/docs/api/intro)
 
 ```bash
 python -m pip install --upgrade pip setuptools wheel
-python -m pip install '.[test]'
+python -m pip install '.[test,lint]'
 ```
 
 ### Run tests
@@ -74,6 +76,12 @@ python -m pip install '.[test]'
 pytest
 ```
 
+### Lint
+
+```bash
+ruff format
+```
+
 ## Documentation
 
 The Lago documentation is available at [doc.getlago.com](https://doc.getlago.com/docs/api/intro).

{lago_python_client-1.31.0 → lago_python_client-1.32.0}/README.md

@@ -7,10 +7,10 @@ This is a python wrapper for Lago API
 
 ## Current Releases
 
-| Project            | Release Badge                                                                                       |
-|--------------------|-----------------------------------------------------------------------------------------------------|
-| **Lago**           | [![Lago Release](https://img.shields.io/github/v/release/getlago/lago)](https://github.com/getlago/lago/releases) |
-| **Lago Python Client**     | [![Lago Python Client Release](https://img.shields.io/github/v/release/getlago/lago-python-client)](https://github.com/getlago/lago-python-client/releases) |
+| Project                | Release Badge                                                                                                                                               |
+| ---------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **Lago**               | [![Lago Release](https://img.shields.io/github/v/release/getlago/lago)](https://github.com/getlago/lago/releases)                                           |
+| **Lago Python Client** | [![Lago Python Client Release](https://img.shields.io/github/v/release/getlago/lago-python-client)](https://github.com/getlago/lago-python-client/releases) |
 
 ## Installation
 
@@ -32,7 +32,7 @@ Check the [lago API reference](https://doc.getlago.com/docs/api/intro)
 
 ```bash
 python -m pip install --upgrade pip setuptools wheel
-python -m pip install '.[test]'
+python -m pip install '.[test,lint]'
 ```
 
 ### Run tests
@@ -41,6 +41,12 @@ python -m pip install '.[test]'
 pytest
 ```
 
+### Lint
+
+```bash
+ruff format
+```
+
 ## Documentation
 
 The Lago documentation is available at [doc.getlago.com](https://doc.getlago.com/docs/api/intro).

lago_python_client-1.32.0/lago_python_client/api_logs/clients.py

@@ -0,0 +1,18 @@
+from typing import ClassVar, Type
+
+from ..base_client import BaseClient
+from ..mixins import (
+    FindAllCommandMixin,
+    FindCommandMixin,
+)
+from ..models.api_log import ApiLogResponse
+
+
+class ApiLogClient(
+    FindAllCommandMixin[ApiLogResponse],
+    FindCommandMixin[ApiLogResponse],
+    BaseClient,
+):
+    API_RESOURCE: ClassVar[str] = "api_logs"
+    RESPONSE_MODEL: ClassVar[Type[ApiLogResponse]] = ApiLogResponse
+    ROOT_NAME: ClassVar[str] = "api_log"

{lago_python_client-1.31.0 → lago_python_client-1.32.0}/lago_python_client/client.py

@@ -26,6 +26,7 @@ from .wallets.clients import WalletClient, WalletTransactionClient
 from .webhooks.clients import WebhookClient
 from .webhook_endpoints.clients import WebhookEndpointClient
 from .activity_logs.clients import ActivityLogClient
+from .api_logs.clients import ApiLogClient
 
 try:
     from typing import Final
@@ -169,3 +170,7 @@ class Client:
     @callable_cached_property
     def activity_logs(self) -> ActivityLogClient:
         return ActivityLogClient(self.base_api_url, self.api_key)
+
+    @callable_cached_property
+    def api_logs(self) -> ApiLogClient:
+        return ApiLogClient(self.base_api_url, self.api_key)

{lago_python_client-1.31.0 → lago_python_client-1.32.0}/lago_python_client/models/__init__.py

@@ -1,4 +1,5 @@
 from .activity_log import ActivityLog as ActivityLog, ActivityLogResponse as ActivityLogResponse
+from .api_log import ApiLog as ApiLog, ApiLogResponse as ApiLogResponse
 from .applied_coupon import AppliedCoupon as AppliedCoupon
 from .billable_metric import (
     BillableMetric as BillableMetric,

lago_python_client-1.32.0/lago_python_client/models/api_log.py

@@ -0,0 +1,33 @@
+from typing import Optional
+
+from lago_python_client.base_model import BaseModel
+
+from ..base_model import BaseResponseModel
+
+
+class ApiLog(BaseModel):
+    api_version: str
+    client: str
+    http_method: str
+    http_status: int
+    request_body: dict
+    logged_at: str
+    request_origin: str
+    created_at: str
+    request_path: str
+    request_response: Optional[dict]
+    request_id: str
+
+
+class ApiLogResponse(BaseResponseModel):
+    request_id: str
+    client: str
+    http_method: str
+    http_status: int
+    request_origin: str
+    request_path: str
+    request_body: dict
+    request_response: Optional[dict]
+    api_version: str
+    logged_at: str
+    created_at: str

{lago_python_client-1.31.0 → lago_python_client-1.32.0}/lago_python_client/models/charge.py

@@ -12,6 +12,11 @@ class ChargeFilter(BaseModel):
     values: Optional[Dict[str, List[str]]]
 
 
+class AppliedPricingUnit(BaseModel):
+    code: Optional[str]
+    conversion_rate: Optional[float]
+
+
 class ChargeFilters(BaseModel):
     __root__: List[ChargeFilter]
 
@@ -29,6 +34,7 @@ class Charge(BaseModel):
     properties: Optional[Dict[str, Any]]
     filters: Optional[ChargeFilters]
     tax_codes: Optional[List[str]]
+    applied_pricing_unit: Optional[AppliedPricingUnit]
 
 
 class Charges(BaseModel):

{lago_python_client-1.31.0 → lago_python_client-1.32.0}/lago_python_client/models/customer_usage.py

@@ -12,12 +12,19 @@ class Metric(BaseModel):
     aggregation_type: str
 
 
+class PricingUnitDetails(BaseModel):
+    amount_cents: int
+    short_name: str
+    conversion_rate: float
+
+
 class ChargeFilterUsage(BaseModel):
     invoice_display_name: Optional[str]
     values: Dict[str, List[str]]
     units: str
     amount_cents: int
     events_count: int
+    pricing_unit_details: Optional[PricingUnitDetails]
 
 
 class ChargeObject(BaseModel):
@@ -32,6 +39,7 @@ class GroupedUsage(BaseModel):
     units: float
     grouped_by: Dict[str, str]
     filters: List[ChargeFilterUsage]
+    pricing_unit_details: Optional[PricingUnitDetails]
 
 
 class ChargeUsage(BaseModel):
@@ -43,6 +51,7 @@ class ChargeUsage(BaseModel):
     billable_metric: Metric
     filters: List[ChargeFilterUsage]
     grouped_usage: Optional[List[GroupedUsage]]
+    pricing_unit_details: Optional[PricingUnitDetails]
 
 
 class CustomerUsageResponse(BaseResponseModel):

{lago_python_client-1.31.0 → lago_python_client-1.32.0}/lago_python_client/models/fee.py

@@ -26,6 +26,17 @@ class FeeAppliedTaxes(BaseResponseModel):
     __root__: List[FeeAppliedTax]
 
 
+class PricingUnitDetails(BaseResponseModel):
+    lago_pricing_unit_id: Optional[str]
+    pricing_unit_code: Optional[str]
+    short_name: Optional[str]
+    amount_cents: Optional[int]
+    precise_amount_cents: Optional[str]
+    unit_amount_cents: Optional[int]
+    precise_unit_amount: Optional[str]
+    conversion_rate: Optional[float]
+
+
 class FeeResponse(BaseResponseModel):
     lago_id: Optional[str]
     lago_charge_id: Optional[str]
@@ -59,6 +70,7 @@ class FeeResponse(BaseResponseModel):
     from_date: Optional[str]
     to_date: Optional[str]
     amount_details: Optional[Dict[str, Any]]
+    pricing_unit_details: Optional[PricingUnitDetails]
     billing_entity_code: Optional[str]
 
     item: Optional[InvoiceItemResponse]

{lago_python_client-1.31.0 → lago_python_client-1.32.0}/lago_python_client/models/subscription.py

@@ -44,6 +44,8 @@ class SubscriptionResponse(BaseResponseModel):
     downgrade_plan_date: Optional[str]
     current_billing_period_started_at: Optional[str]
     current_billing_period_ending_at: Optional[str]
+    on_termination_credit_note: Optional[str]
+    on_termination_invoice: Optional[str]
 
 
 class SubscriptionsResponse(BaseResponseModel):

lago_python_client-1.32.0/lago_python_client/version.py

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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: lago-python-client
-Version: 1.31.0
+Version: 1.32.0
 Summary: Lago Python API Client
 Home-page: https://github.com/getlago/lago-python-client
 Author: Lovro Colic
@@ -29,6 +29,8 @@ Provides-Extra: test
 Requires-Dist: mypy==0.971; extra == "test"
 Requires-Dist: pytest; extra == "test"
 Requires-Dist: pytest_httpx; extra == "test"
+Provides-Extra: lint
+Requires-Dist: ruff; extra == "lint"
 Dynamic: license-file
 
 # Lago Python Client
@@ -40,10 +42,10 @@ This is a python wrapper for Lago API
 
 ## Current Releases
 
-| Project            | Release Badge                                                                                       |
-|--------------------|-----------------------------------------------------------------------------------------------------|
-| **Lago**           | [![Lago Release](https://img.shields.io/github/v/release/getlago/lago)](https://github.com/getlago/lago/releases) |
-| **Lago Python Client**     | [![Lago Python Client Release](https://img.shields.io/github/v/release/getlago/lago-python-client)](https://github.com/getlago/lago-python-client/releases) |
+| Project                | Release Badge                                                                                                                                               |
+| ---------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **Lago**               | [![Lago Release](https://img.shields.io/github/v/release/getlago/lago)](https://github.com/getlago/lago/releases)                                           |
+| **Lago Python Client** | [![Lago Python Client Release](https://img.shields.io/github/v/release/getlago/lago-python-client)](https://github.com/getlago/lago-python-client/releases) |
 
 ## Installation
 
@@ -65,7 +67,7 @@ Check the [lago API reference](https://doc.getlago.com/docs/api/intro)
 
 ```bash
 python -m pip install --upgrade pip setuptools wheel
-python -m pip install '.[test]'
+python -m pip install '.[test,lint]'
 ```
 
 ### Run tests
@@ -74,6 +76,12 @@ python -m pip install '.[test]'
 pytest
 ```
 
+### Lint
+
+```bash
+ruff format
+```
+
 ## Documentation
 
 The Lago documentation is available at [doc.getlago.com](https://doc.getlago.com/docs/api/intro).

{lago_python_client-1.31.0 → lago_python_client-1.32.0}/lago_python_client.egg-info/SOURCES.txt

@@ -15,6 +15,8 @@ setup.cfg
 ./lago_python_client/activity_logs/clients.py
 ./lago_python_client/add_ons/__init__.py
 ./lago_python_client/add_ons/clients.py
+./lago_python_client/api_logs/__init__.py
+./lago_python_client/api_logs/clients.py
 ./lago_python_client/billable_metrics/__init__.py
 ./lago_python_client/billable_metrics/clients.py
 ./lago_python_client/billing_entities/__init__.py
@@ -40,6 +42,7 @@ setup.cfg
 ./lago_python_client/models/__init__.py
 ./lago_python_client/models/activity_log.py
 ./lago_python_client/models/add_on.py
+./lago_python_client/models/api_log.py
 ./lago_python_client/models/applied_coupon.py
 ./lago_python_client/models/billable_metric.py
 ./lago_python_client/models/billing_entity.py
@@ -104,6 +107,7 @@ setup.cfg
 ./tests/__init__.py
 ./tests/test_activity_logs_client.py
 ./tests/test_add_on_client.py
+./tests/test_api_logs_client.py
 ./tests/test_applied_coupon_client.py
 ./tests/test_billable_metric_client.py
 ./tests/test_billing_entity_client.py
@@ -152,6 +156,8 @@ lago_python_client/activity_logs/__init__.py
 lago_python_client/activity_logs/clients.py
 lago_python_client/add_ons/__init__.py
 lago_python_client/add_ons/clients.py
+lago_python_client/api_logs/__init__.py
+lago_python_client/api_logs/clients.py
 lago_python_client/billable_metrics/__init__.py
 lago_python_client/billable_metrics/clients.py
 lago_python_client/billing_entities/__init__.py
@@ -177,6 +183,7 @@ lago_python_client/invoices/clients.py
 lago_python_client/models/__init__.py
 lago_python_client/models/activity_log.py
 lago_python_client/models/add_on.py
+lago_python_client/models/api_log.py
 lago_python_client/models/applied_coupon.py
 lago_python_client/models/billable_metric.py
 lago_python_client/models/billing_entity.py
@@ -241,6 +248,7 @@ lago_python_client/webhooks/clients.py
 tests/__init__.py
 tests/test_activity_logs_client.py
 tests/test_add_on_client.py
+tests/test_api_logs_client.py
 tests/test_applied_coupon_client.py
 tests/test_billable_metric_client.py
 tests/test_billing_entity_client.py

{lago_python_client-1.31.0 → lago_python_client-1.32.0}/lago_python_client.egg-info/requires.txt

@@ -4,6 +4,9 @@ orjson~=3.8
 pydantic<3,>=1.10
 typeguard~=3.0.2
 
+[lint]
+ruff
+
 [test]
 mypy==0.971
 pytest

{lago_python_client-1.31.0 → lago_python_client-1.32.0}/setup.cfg

@@ -38,6 +38,8 @@ test =
 	mypy==0.971
 	pytest
 	pytest_httpx
+lint = 
+	ruff
 
 [options.package_data]
 * = py.typed

lago_python_client-1.32.0/tests/test_api_logs_client.py

@@ -0,0 +1,100 @@
+import os
+
+import pytest
+from pytest_httpx import HTTPXMock
+
+from urllib.parse import urlencode
+
+from lago_python_client.client import Client
+from lago_python_client.exceptions import LagoApiError
+
+ENDPOINT = "https://api.getlago.com/api/v1/api_logs"
+
+
+def mock_response(fixture_path):
+    this_dir = os.path.dirname(os.path.abspath(__file__))
+    data_path = os.path.join(this_dir, fixture_path)
+
+    with open(data_path, "rb") as response:
+        return response.read()
+
+
+def test_valid_find_api_log_request(httpx_mock: HTTPXMock):
+    client = Client(api_key="886fe239-927d-4072-ab72-6dd345e8dd0d")
+    request_id = "8fae2f0e-fe8e-44d3-bbf7-1c552eba3a24"
+
+    httpx_mock.add_response(
+        method="GET",
+        url=ENDPOINT + f"/{request_id}",
+        content=mock_response("fixtures/api_log.json"),
+    )
+    response = client.api_logs.find(request_id)
+
+    assert response.request_id == request_id
+    assert response.client == "LagoClient.0.0.0"
+
+
+def test_invalid_find_api_log_request(httpx_mock: HTTPXMock):
+    client = Client(api_key="invalid")
+    request_id = "invalid"
+
+    httpx_mock.add_response(
+        method="GET",
+        url=ENDPOINT + f"/{request_id}",
+        status_code=404,
+        content=b"",
+    )
+
+    with pytest.raises(LagoApiError):
+        client.api_logs.find(request_id)
+
+
+def test_valid_find_all_api_log_request(httpx_mock: HTTPXMock):
+    client = Client(api_key="886fe239-927d-4072-ab72-6dd345e8dd0d")
+
+    httpx_mock.add_response(
+        method="GET",
+        url=ENDPOINT,
+        content=mock_response("fixtures/api_log_index.json"),
+    )
+    response = client.api_logs.find_all()
+
+    assert response["api_logs"][0].request_id == "8fae2f0e-fe8e-44d3-bbf7-1c552eba3a24"
+    assert response["api_logs"][1].request_id == "65ec835e-43f4-40ad-a4bd-da663349d583"
+    assert response["meta"]["current_page"] == 1
+
+
+def test_valid_find_all_api_log_request_with_options(httpx_mock: HTTPXMock):
+    client = Client(api_key="886fe239-927d-4072-ab72-6dd345e8dd0d")
+    options = {"per_page": 1, "page": 1}
+
+    httpx_mock.add_response(
+        method="GET",
+        url=ENDPOINT + f"?{urlencode(options)}",
+        content=mock_response("fixtures/api_log_index.json"),
+    )
+    response = client.api_logs.find_all(options)
+
+    assert response["api_logs"][1].request_id == "65ec835e-43f4-40ad-a4bd-da663349d583"
+    assert response["meta"]["current_page"] == 1
+
+
+def test_invalid_find_all_api_log_request(httpx_mock: HTTPXMock):
+    client = Client(api_key="invalid")
+
+    httpx_mock.add_response(
+        method="GET",
+        url=ENDPOINT,
+        status_code=404,
+        content=b"",
+    )
+
+    with pytest.raises(LagoApiError):
+        client.api_logs.find_all()
+
+
+def test_invalid_operations_for_api_log_request():
+    client = Client(api_key="886fe239-927d-4072-ab72-6dd345e8dd0d")
+    assert not hasattr(client.api_logs, "create")
+    assert not hasattr(client.api_logs, "update")
+    assert not hasattr(client.api_logs, "destroy")

{lago_python_client-1.31.0 → lago_python_client-1.32.0}/tests/test_subscription_client.py

@@ -140,6 +140,28 @@ def test_valid_destroy_subscription_request(httpx_mock: HTTPXMock):
     assert response.plan_code == "eartha lynch"
 
 
+def test_valid_destroy_subscription_with_on_termination_actions_request(httpx_mock: HTTPXMock):
+    client = Client(api_key="886fe239-927d-4072-ab72-6dd345e8dd0d")
+    identifier = "sub_id"
+
+    httpx_mock.add_response(
+        method="DELETE",
+        url="https://api.getlago.com/api/v1/subscriptions/"
+        + identifier
+        + "?on_termination_credit_note=skip&on_termination_invoice=skip",
+        content=mock_response(),
+    )
+    response = client.subscriptions.destroy(
+        identifier, {"on_termination_credit_note": "skip", "on_termination_invoice": "skip"}
+    )
+
+    assert response.external_customer_id == "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
+    assert response.status == "active"
+    assert response.plan_code == "eartha lynch"
+    assert response.on_termination_credit_note == "skip"
+    assert response.on_termination_invoice == "skip"
+
+
 def test_valid_destroy_pending_subscription_request(httpx_mock: HTTPXMock):
     client = Client(api_key="886fe239-927d-4072-ab72-6dd345e8dd0d")
     identifier = "sub_id"

lago_python_client-1.31.0/lago_python_client/version.py

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