lago-python-client 1.47.0__tar.gz → 1.48.0__tar.gz

{lago_python_client-1.47.0 → lago_python_client-1.48.0}/PKG-INFO

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

{lago_python_client-1.47.0 → lago_python_client-1.48.0}/lago_python_client/customers/clients.py

@@ -1,4 +1,5 @@
 import json
+import warnings
 from collections.abc import Mapping
 from typing import Any, ClassVar, Optional, Type, Union
 
@@ -46,17 +47,42 @@ class CustomerClient(
         filter_by_charge_id: Optional[str] = None,
         filter_by_charge_code: Optional[str] = None,
         filter_by_group: Optional[dict] = None,
+        filter_by_presentation: Optional[Union[str, list[str]]] = None,
         full_usage: Optional[bool] = None,
+        charge_id: Optional[str] = None,
+        charge_code: Optional[str] = None,
+        billable_metric_code: Optional[str] = None,
+        group: Optional[dict] = None,
     ) -> CustomerUsageResponse:
         query_params: dict[str, Union[str, bool]] = {"external_subscription_id": external_subscription_id}
         if apply_taxes is not None:
             query_params["apply_taxes"] = apply_taxes
+        if charge_id is not None:
+            query_params["charge_id"] = charge_id
+        if charge_code is not None:
+            query_params["charge_code"] = charge_code
+        if billable_metric_code is not None:
+            query_params["billable_metric_code"] = billable_metric_code
+        if group is not None:
+            for k, v in group.items():
+                query_params[f"group[{k}]"] = v
         if filter_by_charge_id is not None:
+            warnings.warn("filter_by_charge_id is deprecated, use charge_id instead", DeprecationWarning, stacklevel=2)
             query_params["filter_by_charge_id"] = filter_by_charge_id
         if filter_by_charge_code is not None:
+            warnings.warn(
+                "filter_by_charge_code is deprecated, use charge_code instead", DeprecationWarning, stacklevel=2
+            )
             query_params["filter_by_charge_code"] = filter_by_charge_code
         if filter_by_group is not None:
+            warnings.warn("filter_by_group is deprecated, use group instead", DeprecationWarning, stacklevel=2)
             query_params["filter_by_group"] = json.dumps(filter_by_group)
+        if filter_by_presentation is not None:
+            query_params["filter_by_presentation"] = (
+                filter_by_presentation
+                if isinstance(filter_by_presentation, str)
+                else json.dumps(filter_by_presentation)
+            )
         if full_usage is not None:
             query_params["full_usage"] = str(full_usage).lower()
 

{lago_python_client-1.47.0 → lago_python_client-1.48.0}/lago_python_client/models/__init__.py

@@ -138,6 +138,12 @@ from .customer_usage import (
 from .customer_usage import (
     Metric as Metric,
 )
+from .customer_usage import (
+    PresentationBreakdown as PresentationBreakdown,
+)
+from .customer_usage import (
+    PresentationBreakdowns as PresentationBreakdowns,
+)
 from .event import BatchEvent as BatchEvent
 from .event import Event as Event
 from .fee import Fee as Fee

{lago_python_client-1.47.0 → lago_python_client-1.48.0}/lago_python_client/models/customer_projected_usage.py

@@ -3,6 +3,7 @@ from typing import Dict, List, Optional
 from lago_python_client.base_model import BaseModel
 
 from ..base_model import BaseResponseModel
+from .customer_usage import PresentationBreakdowns
 
 
 class Metric(BaseModel):
@@ -27,6 +28,8 @@ class ProjectedChargeFilterUsage(BaseModel):
     projected_amount_cents: int
     events_count: int
     pricing_unit_details: Optional[PricingUnitDetails]
+    presentation_breakdowns: Optional[PresentationBreakdowns]
+    projected_presentation_breakdowns: Optional[PresentationBreakdowns]
 
 
 class ChargeObject(BaseModel):
@@ -44,6 +47,8 @@ class ProjectedGroupedUsage(BaseModel):
     grouped_by: Dict[str, Optional[str]]
     filters: List[ProjectedChargeFilterUsage]
     pricing_unit_details: Optional[PricingUnitDetails]
+    presentation_breakdowns: Optional[PresentationBreakdowns]
+    projected_presentation_breakdowns: Optional[PresentationBreakdowns]
 
 
 class ProjectedChargeUsage(BaseModel):
@@ -58,6 +63,8 @@ class ProjectedChargeUsage(BaseModel):
     filters: List[ProjectedChargeFilterUsage]
     grouped_usage: Optional[List[ProjectedGroupedUsage]]
     pricing_unit_details: Optional[PricingUnitDetails]
+    presentation_breakdowns: Optional[PresentationBreakdowns]
+    projected_presentation_breakdowns: Optional[PresentationBreakdowns]
 
 
 class CustomerProjectedUsageResponse(BaseResponseModel):

{lago_python_client-1.47.0 → lago_python_client-1.48.0}/lago_python_client/models/customer_usage.py

@@ -18,6 +18,15 @@ class PricingUnitDetails(BaseModel):
     conversion_rate: float
 
 
+class PresentationBreakdown(BaseModel):
+    presentation_by: Dict[str, str]
+    units: str
+
+
+class PresentationBreakdowns(BaseModel):
+    __root__: List[PresentationBreakdown]
+
+
 class ChargeFilterUsage(BaseModel):
     invoice_display_name: Optional[str]
     values: Optional[Dict[str, List[str]]]
@@ -26,6 +35,7 @@ class ChargeFilterUsage(BaseModel):
     amount_cents: int
     events_count: int
     pricing_unit_details: Optional[PricingUnitDetails]
+    presentation_breakdowns: Optional[PresentationBreakdowns]
 
 
 class ChargeObject(BaseModel):
@@ -42,6 +52,7 @@ class GroupedUsage(BaseModel):
     grouped_by: Dict[str, Optional[str]]
     filters: List[ChargeFilterUsage]
     pricing_unit_details: Optional[PricingUnitDetails]
+    presentation_breakdowns: Optional[PresentationBreakdowns]
 
 
 class ChargeUsage(BaseModel):
@@ -55,6 +66,7 @@ class ChargeUsage(BaseModel):
     filters: List[ChargeFilterUsage]
     grouped_usage: Optional[List[GroupedUsage]]
     pricing_unit_details: Optional[PricingUnitDetails]
+    presentation_breakdowns: Optional[PresentationBreakdowns]
 
 
 class CustomerUsageResponse(BaseResponseModel):

{lago_python_client-1.47.0 → lago_python_client-1.48.0}/lago_python_client/models/fee.py

@@ -1,6 +1,7 @@
 from typing import Any, Dict, List, Optional
 
 from ..base_model import BaseModel, BaseResponseModel
+from .customer_usage import PresentationBreakdowns
 from .invoice_item import InvoiceItemResponse
 
 
@@ -75,6 +76,7 @@ class FeeResponse(BaseResponseModel):
     to_date: Optional[str]
     amount_details: Optional[Dict[str, Any]]
     pricing_unit_details: Optional[PricingUnitDetails]
+    presentation_breakdowns: Optional[PresentationBreakdowns]
     billing_entity_code: Optional[str]
 
     item: Optional[InvoiceItemResponse]

{lago_python_client-1.47.0 → lago_python_client-1.48.0}/lago_python_client/models/organization.py

@@ -56,3 +56,4 @@ class OrganizationResponse(BaseResponseModel):
     email_settings: Optional[List[str]]
     finalize_zero_amount_invoice: Optional[bool]
     billing_configuration: Optional[OrganizationBillingConfiguration]
+    events_store: Optional[str]

{lago_python_client-1.47.0 → lago_python_client-1.48.0}/lago_python_client/models/subscription.py

@@ -19,6 +19,7 @@ class Subscription(BaseModel):
     plan_overrides: Optional[PlanOverrides]
     payment_method: Optional[PaymentMethod]
     invoice_custom_section: Optional[InvoiceCustomSectionInput]
+    consolidate_invoice: Optional[bool]
 
 
 class Subscriptions(BaseModel):
@@ -55,6 +56,7 @@ class SubscriptionResponse(BaseResponseModel):
     on_termination_invoice: Optional[str]
     payment_method: Optional[PaymentMethod]
     applied_invoice_custom_sections: Optional[AppliedInvoiceCustomSections]
+    consolidate_invoice: Optional[bool]
 
 
 class SubscriptionsResponse(BaseResponseModel):

lago_python_client-1.48.0/lago_python_client/version.py

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

{lago_python_client-1.47.0 → lago_python_client-1.48.0}/lago_python_client.egg-info/PKG-INFO

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

{lago_python_client-1.47.0 → lago_python_client-1.48.0}/tests/test_customer_client.py

@@ -134,6 +134,11 @@ def test_valid_current_usage(httpx_mock: HTTPXMock):
     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"]
+    charge_usage = response.charges_usage[0]
+    assert charge_usage.presentation_breakdowns.__root__[0].presentation_by["team"] == "engineering"
+    assert charge_usage.presentation_breakdowns.__root__[0].units == "3.0"
+    assert charge_usage.filters[0].presentation_breakdowns.__root__[0].units == "2.0"
+    assert charge_usage.grouped_usage[0].presentation_breakdowns.__root__[0].units == "1.0"
 
 
 def test_valid_projected_usage(httpx_mock: HTTPXMock):
@@ -157,6 +162,11 @@ def test_valid_projected_usage(httpx_mock: HTTPXMock):
     assert response.charges_usage[0].charge.charge_model == "graduated"
     assert response.charges_usage[0].charge.invoice_display_name == "add_on_invoice_display_name"
     assert response.charges_usage[0].billable_metric.lago_id == "99a6094e-199b-4101-896a-54e927ce7bd7"
+    charge_usage = response.charges_usage[0]
+    assert charge_usage.presentation_breakdowns.__root__[0].units == "3.0"
+    assert charge_usage.projected_presentation_breakdowns.__root__[0].units == "6.0"
+    assert charge_usage.filters[0].projected_presentation_breakdowns.__root__[0].units == "4.0"
+    assert charge_usage.grouped_usage[0].projected_presentation_breakdowns.__root__[0].units == "2.0"
 
 
 def test_valid_current_usage_without_taxes(httpx_mock: HTTPXMock):
@@ -204,6 +214,38 @@ def test_valid_current_usage_with_filters(httpx_mock: HTTPXMock):
     assert len(response.charges_usage) == 1
 
 
+def test_valid_current_usage_with_new_filters(httpx_mock: HTTPXMock):
+    client = Client(api_key="886fe239-927d-4072-ab72-6dd345e8dd0d")
+    charge_id = "1a901a90-1a90-1a90-1a90-1a901a901a90"
+
+    httpx_mock.add_response(
+        method="GET",
+        url=(
+            "https://api.getlago.com/api/v1/customers/external_customer_id/current_usage"
+            f"?external_subscription_id=123&charge_id={charge_id}"
+            "&charge_code=storage"
+            "&billable_metric_code=storage"
+            "&group%5Bcloud%5D=aws"
+            "&filter_by_presentation=%5B%22engineering%22%2C+%22operations%22%5D"
+            "&full_usage=true"
+        ),
+        content=mock_response("customer_usage"),
+    )
+    response = client.customers.current_usage(
+        "external_customer_id",
+        "123",
+        charge_id=charge_id,
+        charge_code="storage",
+        billable_metric_code="storage",
+        group={"cloud": "aws"},
+        filter_by_presentation=["engineering", "operations"],
+        full_usage=True,
+    )
+
+    assert response.from_datetime == "2022-07-01T00:00:00Z"
+    assert len(response.charges_usage) == 1
+
+
 def test_invalid_current_usage(httpx_mock: HTTPXMock):
     client = Client(api_key="886fe239-927d-4072-ab72-6dd345e8dd0d")
 
@@ -233,6 +275,8 @@ def test_valid_past_usage(httpx_mock: HTTPXMock):
     assert len(response["usage_periods"][0].charges_usage) == 1
     assert response["usage_periods"][0].charges_usage[0].units == "1.0"
     assert len(response["usage_periods"][0].charges_usage[0].filters) == 1
+    past_charge_usage = response["usage_periods"][0].charges_usage[0]
+    assert past_charge_usage.presentation_breakdowns.__root__[0].units == "3.0"
 
 
 def test_invalid_past_usage(httpx_mock: HTTPXMock):

{lago_python_client-1.47.0 → lago_python_client-1.48.0}/tests/test_fee_client.py

@@ -29,6 +29,8 @@ def test_valid_find_fee_request(httpx_mock: HTTPXMock):
     assert response.lago_id == identifier
     assert response.invoice_display_name == fee_invoice_display_name
     assert response.item.invoice_display_name == charge_invoice_display_name
+    assert response.presentation_breakdowns.__root__[0].presentation_by["team"] == "engineering"
+    assert response.presentation_breakdowns.__root__[0].units == "10.0"
 
 
 def test_fee_response_with_fixed_charge_id():

{lago_python_client-1.47.0 → lago_python_client-1.48.0}/tests/test_plan_client.py

@@ -25,7 +25,14 @@ def plan_object():
         id=None,
         invoice_display_name=None,
         regroup_paid_fees=None,
-        properties=None,
+        properties={
+            "presentation_group_keys": [
+                {
+                    "value": "region",
+                    "options": {"display_in_invoice": True},
+                }
+            ]
+        },
         tax_codes=None,
         billable_metric_id="id",
         charge_model="standard",
@@ -194,6 +201,8 @@ def test_valid_create_plan_request(httpx_mock: HTTPXMock):
     assert response.code == "plan_code"
     assert response.invoice_display_name == "test plan 1"
     assert response.charges.__root__[0].invoice_display_name == "Setup"
+    charge = response.charges.__root__[0]
+    assert charge.properties["presentation_group_keys"][0]["value"] == "region"
     assert response.minimum_commitment.invoice_display_name == "Minimum commitment (C1)"
     assert response.usage_thresholds.__root__[0].threshold_display_name == "Threshold 1"
     assert response.metadata == {"key1": "value1", "key2": None}
@@ -276,6 +285,8 @@ def test_valid_find_plan_request(httpx_mock: HTTPXMock):
     assert response.invoice_display_name == "test plan 1"
     assert response.charges.__root__[0].charge_model == "standard"
     assert response.charges.__root__[0].min_amount_cents == 0
+    charge = response.charges.__root__[0]
+    assert charge.properties["presentation_group_keys"][0]["value"] == "region"
     assert response.minimum_commitment.amount_cents == 1000
 
 
@@ -338,6 +349,8 @@ def test_valid_find_all_plan_request(httpx_mock: HTTPXMock):
     assert response["plans"][0].invoice_display_name == "test plan 1"
     assert response["plans"][0].minimum_commitment.invoice_display_name == "Minimum commitment (C2)"
     assert response["plans"][0].charges.__root__[0].lago_id == "51c1e851-5be6-4343-a0ee-39a81d8b4ee1"
+    plan_charge = response["plans"][0].charges.__root__[0]
+    assert plan_charge.properties["presentation_group_keys"][0]["value"] == "region"
     assert response["plans"][0].charges.__root__[0].filters.__root__[0].properties["amount"] == "0.22"
     assert response["plans"][0].charges.__root__[0].filters.__root__[0].invoice_display_name == "Europe"
     assert response["meta"]["current_page"] == 1
@@ -506,6 +519,9 @@ def test_valid_find_charge_request(httpx_mock: HTTPXMock):
     assert response.code == "charge_code"
     assert response.charge_model == "standard"
     assert response.invoice_display_name == "Setup"
+    presentation_group_key = response.properties["presentation_group_keys"][0]
+    assert presentation_group_key["value"] == "region"
+    assert presentation_group_key["options"]["display_in_invoice"] is True
 
 
 def test_valid_create_charge_request(httpx_mock: HTTPXMock):
@@ -522,12 +538,21 @@ def test_valid_create_charge_request(httpx_mock: HTTPXMock):
         charge_model="standard",
         pay_in_advance=True,
         invoiceable=True,
-        properties={"amount": "0.22"},
+        properties={
+            "amount": "0.22",
+            "presentation_group_keys": [
+                {
+                    "value": "region",
+                    "options": {"display_in_invoice": True},
+                }
+            ],
+        },
     )
     response = client.plan_charges.create(plan_code, charge)
 
     assert response.lago_id == "51c1e851-5be6-4343-a0ee-39a81d8b4ee1"
     assert response.charge_model == "standard"
+    assert charge.dict()["properties"]["presentation_group_keys"][0]["value"] == "region"
 
 
 def test_valid_update_charge_request(httpx_mock: HTTPXMock):

{lago_python_client-1.47.0 → lago_python_client-1.48.0}/tests/test_subscription_client.py

@@ -26,6 +26,7 @@ def create_subscription():
         billing_time="anniversary",
         subscription_at="2022-04-29T08:59:51Z",
         ending_at="2022-08-29T08:59:51Z",
+        consolidate_invoice=False,
     )
 
 
@@ -85,6 +86,7 @@ def test_valid_create_subscriptions_request(httpx_mock: HTTPXMock):
     assert response.billing_time == "anniversary"
     assert response.subscription_at == "2022-04-29T08:59:51Z"
     assert response.ending_at == "2022-08-29T08:59:51Z"
+    assert response.consolidate_invoice is False
 
 
 def test_valid_create_subscriptions_request_with_payment_method(httpx_mock: HTTPXMock):
@@ -637,6 +639,9 @@ def test_valid_find_charge_request(httpx_mock: HTTPXMock):
     assert response.code == "charge_code"
     assert response.charge_model == "standard"
     assert response.invoice_display_name == "Setup"
+    presentation_group_key = response.properties["presentation_group_keys"][0]
+    assert presentation_group_key["value"] == "region"
+    assert presentation_group_key["options"]["display_in_invoice"] is True
 
 
 def test_valid_update_charge_request(httpx_mock: HTTPXMock):

lago_python_client-1.47.0/lago_python_client/version.py

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