lago-python-client 1.40.0__tar.gz → 1.41.4__tar.gz

{lago_python_client-1.40.0 → lago_python_client-1.41.4}/PKG-INFO

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

{lago_python_client-1.40.0 → lago_python_client-1.41.4}/lago_python_client/models/__init__.py

@@ -1,4 +1,14 @@
 from .activity_log import ActivityLog as ActivityLog, ActivityLogResponse as ActivityLogResponse
+from .alert import (
+    Alert as Alert,
+    AlertsList as AlertsList,
+    AlertThreshold as AlertThreshold,
+    AlertThresholdList as AlertThresholdList,
+    AlertResponse as AlertResponse,
+    AlertsResponseList as AlertsResponseList,
+    AlertThresholdResponse as AlertThresholdResponse,
+    AlertThresholdResponseList as AlertThresholdResponseList,
+)
 from .api_log import ApiLog as ApiLog, ApiLogResponse as ApiLogResponse
 from .applied_coupon import AppliedCoupon as AppliedCoupon
 from .billable_metric import (

lago_python_client-1.41.4/lago_python_client/models/alert.py

@@ -0,0 +1,54 @@
+from typing import List, Optional
+
+from ..base_model import BaseModel, BaseResponseModel
+from .billable_metric import BillableMetricResponse
+
+
+class AlertThreshold(BaseModel):
+    code: Optional[str]
+    value: str
+    recurring: Optional[bool]
+
+
+class AlertThresholdList(BaseModel):
+    __root__: List[AlertThreshold]
+
+
+class Alert(BaseModel):
+    alert_type: str
+    code: str
+    name: Optional[str]
+    billable_metric_code: Optional[str]
+    thresholds: AlertThresholdList
+
+
+class AlertsList(BaseModel):
+    alerts: List[Alert]
+
+
+class AlertThresholdResponse(BaseResponseModel):
+    code: Optional[str]
+    value: str
+    recurring: bool
+
+
+class AlertThresholdResponseList(BaseResponseModel):
+    __root__: List[AlertThresholdResponse]
+
+
+class AlertResponse(BaseResponseModel):
+    lago_id: str
+    lago_organization_id: str
+    external_subscription_id: str
+    alert_type: str
+    code: str
+    name: Optional[str]
+    previous_value: Optional[str]
+    last_processed_at: Optional[str]
+    thresholds: AlertThresholdResponseList
+    created_at: str
+    billable_metric: Optional[BillableMetricResponse]
+
+
+class AlertsResponseList(BaseResponseModel):
+    alerts: List[AlertResponse]

{lago_python_client-1.40.0 → lago_python_client-1.41.4}/lago_python_client/models/charge.py

@@ -35,6 +35,7 @@ class Charge(BaseModel):
     filters: Optional[ChargeFilters]
     tax_codes: Optional[List[str]]
     applied_pricing_unit: Optional[AppliedPricingUnit]
+    accepts_target_wallet: Optional[bool]
 
 
 class Charges(BaseModel):
@@ -55,6 +56,7 @@ class ChargeResponse(BaseResponseModel):
     properties: Optional[Dict[str, Any]]
     filters: Optional[ChargeFilters]
     taxes: Optional[TaxesResponse]
+    accepts_target_wallet: Optional[bool]
 
 
 class ChargesResponse(BaseResponseModel):

{lago_python_client-1.40.0 → lago_python_client-1.41.4}/lago_python_client/models/credit_note.py

@@ -1,6 +1,7 @@
 from typing import Dict, List, Optional
 
 from lago_python_client.base_model import BaseModel
+from .customer import CustomerResponse
 
 from .fee import FeeResponse
 from ..base_model import BaseResponseModel
@@ -60,6 +61,7 @@ class CreditNoteResponse(BaseResponseModel):
     items: Optional[ItemsResponse]
     applied_taxes: Optional[CreditNoteAppliedTaxes]
     metadata: Optional[Dict[str, Optional[str]]]
+    customer: Optional[CustomerResponse]
 
 
 class Item(BaseModel):

{lago_python_client-1.40.0 → lago_python_client-1.41.4}/lago_python_client/models/subscription.py

@@ -29,6 +29,8 @@ class SubscriptionResponse(BaseResponseModel):
     canceled_at: Optional[str]
     created_at: Optional[str]
     plan_code: Optional[str]
+    plan_amount_cents: Optional[str]
+    plan_amount_currency: Optional[str]
     started_at: Optional[str]
     status: Optional[str]
     name: Optional[str]

{lago_python_client-1.40.0 → lago_python_client-1.41.4}/lago_python_client/models/wallet.py

@@ -56,6 +56,7 @@ class Wallet(BaseModel):
     external_customer_id: Optional[str]
     rate_amount: Optional[str]
     name: Optional[str]
+    code: Optional[str]
     priority: Optional[int]
     paid_credits: Optional[str]
     granted_credits: Optional[str]
@@ -79,6 +80,7 @@ class WalletResponse(BaseResponseModel):
     status: str
     currency: str
     name: Optional[str]
+    code: Optional[str]
     priority: Optional[int]
     rate_amount: str
     credits_balance: str

{lago_python_client-1.40.0 → lago_python_client-1.41.4}/lago_python_client/subscriptions/clients.py

@@ -8,13 +8,16 @@ from ..mixins import (
     FindCommandMixin,
     UpdateCommandMixin,
 )
+from ..models.alert import AlertResponse, AlertsList
 from ..models.fixed_charge import FixedChargeResponse
 from ..models.lifetime_usage import LifetimeUsageResponse
 from ..models.subscription import SubscriptionResponse
 from ..services.request import (
     make_headers,
     make_url,
+    send_delete_request,
     send_get_request,
+    send_post_request,
     send_put_request,
 )
 from ..services.response import (
@@ -22,6 +25,7 @@ from ..services.response import (
     get_response_data,
     prepare_index_response,
     prepare_object_response,
+    verify_response,
 )
 from ..services.json import to_json
 
@@ -71,6 +75,32 @@ class SubscriptionClient(
             data=get_response_data(response=api_response, key="lifetime_usage"),
         )
 
+    def create_alerts(self, external_id: str, input_object: AlertsList) -> Mapping[str, Any]:
+        api_response: Response = send_post_request(
+            url=make_url(
+                origin=self.base_url,
+                path_parts=(self.API_RESOURCE, external_id, "alerts"),
+            ),
+            content=to_json(input_object.dict()),
+            headers=make_headers(api_key=self.api_key),
+        )
+
+        return prepare_index_response(
+            api_resource="alerts",
+            response_model=AlertResponse,
+            data=get_response_data(response=api_response),
+        )
+
+    def delete_alerts(self, external_id: str) -> None:
+        api_response: Response = send_delete_request(
+            url=make_url(
+                origin=self.base_url,
+                path_parts=(self.API_RESOURCE, external_id, "alerts"),
+            ),
+            headers=make_headers(api_key=self.api_key),
+        )
+        verify_response(api_response)
+
     def find_all_fixed_charges(self, external_id: str) -> Mapping[str, Any]:
         api_response: Response = send_get_request(
             url=make_url(

lago_python_client-1.41.4/lago_python_client/version.py

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

{lago_python_client-1.40.0 → lago_python_client-1.41.4}/lago_python_client.egg-info/PKG-INFO

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

{lago_python_client-1.40.0 → lago_python_client-1.41.4}/lago_python_client.egg-info/SOURCES.txt

@@ -49,6 +49,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/alert.py
 ./lago_python_client/models/api_log.py
 ./lago_python_client/models/applied_coupon.py
 ./lago_python_client/models/billable_metric.py
@@ -213,6 +214,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/alert.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-1.40.0 → lago_python_client-1.41.4}/tests/test_credit_note_client.py

@@ -51,6 +51,14 @@ def mock_response():
         return credit_note_response.read()
 
 
+def mock_response_with_customer():
+    current_dir = os.path.dirname(os.path.abspath(__file__))
+    data_path = os.path.join(current_dir, "fixtures/credit_note_with_customer.json")
+
+    with open(data_path, "rb") as credit_note_response:
+        return credit_note_response.read()
+
+
 def mock_collection_response():
     current_dir = os.path.dirname(os.path.abspath(__file__))
     data_path = os.path.join(current_dir, "fixtures/credit_note_index.json")
@@ -74,11 +82,12 @@ def test_valid_find_credit_note_request(httpx_mock: HTTPXMock):
     httpx_mock.add_response(
         method="GET",
         url="https://api.getlago.com/api/v1/credit_notes/" + identifier,
-        content=mock_response(),
+        content=mock_response_with_customer(),
     )
     response = client.credit_notes.find(identifier)
 
     assert response.lago_id == identifier
+    assert response.customer.lago_id == "99a6094e-199b-4101-896a-54e927ce7bd7"
 
 
 def test_invalid_find_invoice_request(httpx_mock: HTTPXMock):
@@ -129,12 +138,13 @@ def test_valid_create_credit_note_request(httpx_mock: HTTPXMock):
     httpx_mock.add_response(
         method="POST",
         url="https://api.getlago.com/api/v1/credit_notes",
-        content=mock_response(),
+        content=mock_response_with_customer(),
     )
     response = client.credit_notes.create(credit_note_object())
 
     assert response.lago_id == "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
     assert response.refund_status == "pending"
+    assert response.customer.lago_id == "99a6094e-199b-4101-896a-54e927ce7bd7"
 
 
 def test_invalid_create_credit_note_request(httpx_mock: HTTPXMock):
@@ -158,12 +168,13 @@ def test_valid_update_credit_note_request(httpx_mock: HTTPXMock):
     httpx_mock.add_response(
         method="PUT",
         url="https://api.getlago.com/api/v1/credit_notes/" + credit_note_id,
-        content=mock_response(),
+        content=mock_response_with_customer(),
     )
     response = client.credit_notes.update(credit_note_update_object(), credit_note_id)
 
     assert response.lago_id == "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
     assert response.refund_status == "pending"
+    assert response.customer.lago_id == "99a6094e-199b-4101-896a-54e927ce7bd7"
 
 
 def test_valid_void_credit_note_request(httpx_mock: HTTPXMock):
@@ -173,12 +184,13 @@ def test_valid_void_credit_note_request(httpx_mock: HTTPXMock):
     httpx_mock.add_response(
         method="PUT",
         url="https://api.getlago.com/api/v1/credit_notes/" + credit_note_id + "/void",
-        content=mock_response(),
+        content=mock_response_with_customer(),
     )
     response = client.credit_notes.void(credit_note_id)
 
     assert response.lago_id == "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
     assert response.refund_status == "pending"
+    assert response.customer.lago_id == "99a6094e-199b-4101-896a-54e927ce7bd7"
 
 
 def test_valid_estimate_credit_note_request(httpx_mock: HTTPXMock):

{lago_python_client-1.40.0 → lago_python_client-1.41.4}/tests/test_subscription_client.py

@@ -6,6 +6,7 @@ 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 Subscription
+from lago_python_client.models.alert import Alert, AlertThreshold, AlertsList
 
 
 def create_subscription():
@@ -400,3 +401,95 @@ def test_fixed_charge_response_model_parsing():
     assert response.properties.graduated_ranges[0].from_value == 0
     assert response.properties.graduated_ranges[0].per_unit_amount == "100"
     assert response.properties.graduated_ranges[1].to_value is None
+
+
+def mock_subscription_alerts_response():
+    this_dir = os.path.dirname(os.path.abspath(__file__))
+    my_data_path = os.path.join(this_dir, "fixtures/subscription_alerts.json")
+
+    with open(my_data_path, "rb") as alerts_response:
+        return alerts_response.read()
+
+
+def test_valid_create_alerts_request(httpx_mock: HTTPXMock):
+    client = Client(api_key="886fe239-927d-4072-ab72-6dd345e8dd0d")
+    external_id = "sub_1234"
+
+    httpx_mock.add_response(
+        method="POST",
+        url="https://api.getlago.com/api/v1/subscriptions/" + external_id + "/alerts",
+        content=mock_subscription_alerts_response(),
+    )
+
+    input_object = AlertsList(
+        alerts=[
+            Alert(
+                alert_type="current_usage_amount",
+                code="alert1",
+                name="First Alert",
+                thresholds=[AlertThreshold(code="warn", value="1000")],
+            ),
+            Alert(
+                alert_type="billable_metric_current_usage_amount",
+                code="alert2",
+                billable_metric_code="storage",
+                thresholds=[AlertThreshold(value="2000")],
+            ),
+        ]
+    )
+
+    response = client.subscriptions.create_alerts(external_id, input_object)
+
+    assert len(response["alerts"]) == 2
+    assert response["alerts"][0].lago_id == "1a901a90-1a90-1a90-1a90-1a901a901a90"
+    assert response["alerts"][0].code == "alert1"
+    assert response["alerts"][0].alert_type == "current_usage_amount"
+    assert response["alerts"][1].lago_id == "3c903c90-3c90-3c90-3c90-3c903c903c90"
+    assert response["alerts"][1].code == "alert2"
+
+
+def test_invalid_create_alerts_request(httpx_mock: HTTPXMock):
+    client = Client(api_key="invalid")
+    external_id = "sub_1234"
+
+    httpx_mock.add_response(
+        method="POST",
+        url="https://api.getlago.com/api/v1/subscriptions/" + external_id + "/alerts",
+        status_code=422,
+        content=b"",
+    )
+
+    input_object = AlertsList(alerts=[])
+
+    with pytest.raises(LagoApiError):
+        client.subscriptions.create_alerts(external_id, input_object)
+
+
+def test_valid_delete_alerts_request(httpx_mock: HTTPXMock):
+    client = Client(api_key="886fe239-927d-4072-ab72-6dd345e8dd0d")
+    external_id = "sub_1234"
+
+    httpx_mock.add_response(
+        method="DELETE",
+        url="https://api.getlago.com/api/v1/subscriptions/" + external_id + "/alerts",
+        status_code=200,
+        content=b"",
+    )
+
+    result = client.subscriptions.delete_alerts(external_id)
+    assert result is None
+
+
+def test_invalid_delete_alerts_request(httpx_mock: HTTPXMock):
+    client = Client(api_key="invalid")
+    external_id = "invalid_sub"
+
+    httpx_mock.add_response(
+        method="DELETE",
+        url="https://api.getlago.com/api/v1/subscriptions/" + external_id + "/alerts",
+        status_code=404,
+        content=b"",
+    )
+
+    with pytest.raises(LagoApiError):
+        client.subscriptions.delete_alerts(external_id)

{lago_python_client-1.40.0 → lago_python_client-1.41.4}/tests/test_wallet_client.py

@@ -31,6 +31,7 @@ def wallet_object():
     )
     return Wallet(
         name="name",
+        code="wallet_code",
         priority=30,
         external_customer_id="12345",
         rate_amount="1",
@@ -73,6 +74,7 @@ def test_valid_create_wallet_request(httpx_mock: HTTPXMock):
                 "external_customer_id": "12345",
                 "rate_amount": "1",
                 "name": "name",
+                "code": "wallet_code",
                 "priority": 30,
                 "paid_credits": "10",
                 "granted_credits": "10",

lago_python_client-1.40.0/lago_python_client/version.py

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