lago-python-client 1.27.1__tar.gz → 1.30.0__tar.gz

{lago_python_client-1.27.1 → lago_python_client-1.30.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: lago-python-client
-Version: 1.27.1
+Version: 1.30.0
 Summary: Lago Python API Client
 Home-page: https://github.com/getlago/lago-python-client
 Author: Lovro Colic
@@ -65,7 +65,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]'
 ```
 
 ### Run tests

{lago_python_client-1.27.1 → lago_python_client-1.30.0}/README.md

@@ -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]'
 ```
 
 ### Run tests

lago_python_client-1.30.0/lago_python_client/activity_logs/clients.py

@@ -0,0 +1,18 @@
+from typing import ClassVar, Type
+
+from ..base_client import BaseClient
+from ..mixins import (
+    FindAllCommandMixin,
+    FindCommandMixin,
+)
+from ..models.activity_log import ActivityLogResponse
+
+
+class ActivityLogClient(
+    FindAllCommandMixin[ActivityLogResponse],
+    FindCommandMixin[ActivityLogResponse],
+    BaseClient,
+):
+    API_RESOURCE: ClassVar[str] = "activity_logs"
+    RESPONSE_MODEL: ClassVar[Type[ActivityLogResponse]] = ActivityLogResponse
+    ROOT_NAME: ClassVar[str] = "activity_log"

lago_python_client-1.30.0/lago_python_client/billing_entities/clients.py

@@ -0,0 +1,24 @@
+from typing import ClassVar, Type
+
+from ..base_client import BaseClient
+from ..mixins import (
+    CreateCommandMixin,
+    FindAllCommandMixin,
+    FindCommandMixin,
+    UpdateCommandMixin,
+)
+from ..models.billing_entity import (
+    BillingEntityResponse,
+)
+
+
+class BillingEntityClient(
+    CreateCommandMixin[BillingEntityResponse],
+    FindAllCommandMixin[BillingEntityResponse],
+    FindCommandMixin[BillingEntityResponse],
+    UpdateCommandMixin[BillingEntityResponse],
+    BaseClient,
+):
+    API_RESOURCE: ClassVar[str] = "billing_entities"
+    RESPONSE_MODEL: ClassVar[Type[BillingEntityResponse]] = BillingEntityResponse
+    ROOT_NAME: ClassVar[str] = "billing_entity"

{lago_python_client-1.27.1 → lago_python_client-1.30.0}/lago_python_client/client.py

@@ -2,6 +2,7 @@ from urllib.parse import urljoin
 
 from .add_ons.clients import AddOnClient
 from .billable_metrics.clients import BillableMetricClient
+from .billing_entities.clients import BillingEntityClient
 from .coupons.clients import AppliedCouponClient, CouponClient
 from .credit_notes.clients import CreditNoteClient
 from .customers.clients import CustomerClient
@@ -24,6 +25,7 @@ from .taxes.clients import TaxClient
 from .wallets.clients import WalletClient, WalletTransactionClient
 from .webhooks.clients import WebhookClient
 from .webhook_endpoints.clients import WebhookEndpointClient
+from .activity_logs.clients import ActivityLogClient
 
 try:
     from typing import Final
@@ -68,6 +70,10 @@ class Client:
     def billable_metrics(self) -> BillableMetricClient:
         return BillableMetricClient(self.base_api_url, self.api_key)
 
+    @callable_cached_property
+    def billing_entities(self) -> BillingEntityClient:
+        return BillingEntityClient(self.base_api_url, self.api_key)
+
     @callable_cached_property
     def coupons(self) -> CouponClient:
         return CouponClient(self.base_api_url, self.api_key)
@@ -159,3 +165,7 @@ class Client:
     @callable_cached_property
     def webhook_endpoints(self) -> WebhookEndpointClient:
         return WebhookEndpointClient(self.base_api_url, self.api_key)
+
+    @callable_cached_property
+    def activity_logs(self) -> ActivityLogClient:
+        return ActivityLogClient(self.base_api_url, self.api_key)

{lago_python_client-1.27.1 → lago_python_client-1.30.0}/lago_python_client/invoices/clients.py

@@ -107,6 +107,20 @@ class InvoiceClient(
             data=get_response_data(response=api_response, key=self.ROOT_NAME),
         )
 
+    def void(self, resource_id: str) -> InvoiceResponse:
+        api_response: Response = send_post_request(
+            url=make_url(
+                origin=self.base_url,
+                path_parts=(self.API_RESOURCE, resource_id, "void"),
+            ),
+            headers=make_headers(api_key=self.api_key),
+        )
+
+        return prepare_object_response(
+            response_model=self.RESPONSE_MODEL,
+            data=get_response_data(response=api_response, key=self.ROOT_NAME),
+        )
+
     def lose_dispute(self, resource_id: str) -> InvoiceResponse:
         api_response: Response = send_put_request(
             url=make_url(

{lago_python_client-1.27.1 → lago_python_client-1.30.0}/lago_python_client/models/__init__.py

@@ -1,3 +1,4 @@
+from .activity_log import ActivityLog as ActivityLog, ActivityLogResponse as ActivityLogResponse
 from .applied_coupon import AppliedCoupon as AppliedCoupon
 from .billable_metric import (
     BillableMetric as BillableMetric,
@@ -7,6 +8,12 @@ from .billable_metric import (
     BillableMetricEvaluateExpression as BillableMetricEvaluateExpression,
     BillableMetricEvaluateExpressionResponse as BillableMetricEvaluateExpressionResponse,
 )
+from .billing_entity import (
+    BillingEntity as BillingEntity,
+    BillingEntityUpdate as BillingEntityUpdate,
+    BillingEntityResponse as BillingEntityResponse,
+    BillingEntityBillingConfiguration as BillingEntityBillingConfiguration,
+)
 from .billing_period import (
     BillingPeriodResponse as BillingPeriodResponse,
     BillingPeriodsResponse as BillingPeriodsResponse,
@@ -82,6 +89,7 @@ from .wallet import (
     RecurringTransactionRuleList as RecurringTransactionRuleList,
     RecurringTransactionRuleResponse as RecurringTransactionRuleResponse,
     RecurringTransactionRuleResponseList as RecurringTransactionRuleResponseList,
+    AppliesTo as AppliesTo,
 )
 from .wallet_transaction import WalletTransaction as WalletTransaction
 from .webhook_endpoint import WebhookEndpoint as WebhookEndpoint

lago_python_client-1.30.0/lago_python_client/models/activity_log.py

@@ -0,0 +1,36 @@
+from typing import Optional
+
+from lago_python_client.base_model import BaseModel
+
+from ..base_model import BaseResponseModel
+
+
+class ActivityLog(BaseModel):
+    activity_type: str
+    activity_object: Optional[dict]
+    activity_object_changes: Optional[dict]
+    activity_source: str
+    activity_type: str
+    logged_at: str
+    resource_type: str
+    created_at: str
+    activity_id: str
+    external_customer_id: Optional[str]
+    external_subscription_id: Optional[str]
+    resource_id: str
+    user_email: Optional[str]
+
+
+class ActivityLogResponse(BaseResponseModel):
+    activity_id: str
+    activity_type: str
+    activity_source: str
+    activity_object: Optional[dict]
+    activity_object_changes: Optional[dict]
+    user_email: Optional[str]
+    resource_id: str
+    resource_type: str
+    external_customer_id: Optional[str]
+    external_subscription_id: Optional[str]
+    logged_at: str
+    created_at: str

lago_python_client-1.30.0/lago_python_client/models/billing_entity.py

@@ -0,0 +1,96 @@
+from typing import Optional, List
+from ..base_model import BaseModel, BaseResponseModel
+from .tax import TaxesResponse
+from datetime import datetime
+
+
+class BillingEntityBillingConfiguration(BaseModel):
+    invoice_footer: Optional[str]
+    invoice_grace_period: Optional[int]
+    document_locale: Optional[str]
+
+
+class BillingEntity(BaseModel):
+    code: str
+    name: str
+    address_line1: Optional[str]
+    address_line2: Optional[str]
+    city: Optional[str]
+    state: Optional[str]
+    zipcode: Optional[str]
+    country: Optional[str]
+    email: Optional[str]
+    phone: Optional[str]
+    default_currency: Optional[str]
+    timezone: Optional[str]
+    document_numbering: Optional[str]
+    document_number_prefix: Optional[str]
+    finalize_zero_amount_invoice: Optional[bool]
+    net_payment_term: Optional[int]
+    eu_tax_management: Optional[bool]
+    logo_url: Optional[str]
+    legal_name: Optional[str]
+    legal_number: Optional[str]
+    tax_identification_number: Optional[str]
+    email_settings: Optional[List[str]]
+    billing_configuration: Optional[BillingEntityBillingConfiguration]
+
+
+class BillingEntityUpdate(BaseModel):
+    name: str
+    address_line1: Optional[str]
+    address_line2: Optional[str]
+    city: Optional[str]
+    state: Optional[str]
+    zipcode: Optional[str]
+    country: Optional[str]
+    email: Optional[str]
+    phone: Optional[str]
+    default_currency: Optional[str]
+    timezone: Optional[str]
+    document_numbering: Optional[str]
+    document_number_prefix: Optional[str]
+    finalize_zero_amount_invoice: Optional[bool]
+    net_payment_term: Optional[int]
+    eu_tax_management: Optional[bool]
+    logo_url: Optional[str]
+    legal_name: Optional[str]
+    legal_number: Optional[str]
+    tax_identification_number: Optional[str]
+    tax_codes: Optional[List[str]]
+    email_settings: Optional[List[str]]
+    billing_configuration: Optional[BillingEntityBillingConfiguration]
+
+
+class BillingEntityResponse(BaseResponseModel):
+    lago_id: str
+    code: str
+    name: str
+    address_line1: Optional[str]
+    address_line2: Optional[str]
+    city: Optional[str]
+    state: Optional[str]
+    zipcode: Optional[str]
+    country: Optional[str]
+    email: Optional[str]
+    phone: Optional[str]
+    default_currency: Optional[str]
+    timezone: Optional[str]
+    document_numbering: Optional[str]
+    document_number_prefix: Optional[str]
+    finalize_zero_amount_invoice: Optional[bool]
+    net_payment_term: Optional[int]
+    eu_tax_management: Optional[bool]
+    logo_url: Optional[str]
+    legal_name: Optional[str]
+    legal_number: Optional[str]
+    tax_identification_number: Optional[str]
+    is_default: bool
+    logo_url: Optional[str]
+    document_locale: Optional[str]
+    invoice_footer: Optional[str]
+    invoice_grace_period: Optional[int]
+    email_settings: Optional[List[str]]
+    taxes: Optional[TaxesResponse]
+    created_at: datetime
+    updated_at: datetime

{lago_python_client-1.27.1 → lago_python_client-1.30.0}/lago_python_client/models/tax.py

@@ -23,7 +23,7 @@ class TaxResponse(BaseResponseModel):
     code: str
     rate: float
     description: Optional[str]
-    applied_to_organization: bool
+    applied_to_organization: Optional[bool]
     created_at: str
 
 

{lago_python_client-1.27.1 → lago_python_client-1.30.0}/lago_python_client/models/wallet.py

@@ -43,6 +43,10 @@ class RecurringTransactionRuleResponseList(BaseModel):
     __root__: List[RecurringTransactionRuleResponse]
 
 
+class AppliesTo(BaseModel):
+    fee_types: Optional[List[str]]
+
+
 class Wallet(BaseModel):
     external_customer_id: Optional[str]
     rate_amount: Optional[str]
@@ -53,6 +57,7 @@ class Wallet(BaseModel):
     currency: Optional[str]
     recurring_transaction_rules: Optional[RecurringTransactionRuleList]
     transaction_metadata: Optional[List[Dict[str, str]]]
+    applies_to: Optional[AppliesTo]
 
 
 class WalletResponse(BaseResponseModel):
@@ -76,3 +81,4 @@ class WalletResponse(BaseResponseModel):
     ongoing_usage_balance_cents: int
     credits_ongoing_balance: str
     credits_ongoing_usage_balance: str
+    applies_to: Optional[AppliesTo]

lago_python_client-1.30.0/lago_python_client/version.py

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

{lago_python_client-1.27.1 → lago_python_client-1.30.0}/lago_python_client.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: lago-python-client
-Version: 1.27.1
+Version: 1.30.0
 Summary: Lago Python API Client
 Home-page: https://github.com/getlago/lago-python-client
 Author: Lovro Colic
@@ -65,7 +65,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]'
 ```
 
 ### Run tests

{lago_python_client-1.27.1 → lago_python_client-1.30.0}/lago_python_client.egg-info/SOURCES.txt

@@ -11,10 +11,14 @@ setup.cfg
 ./lago_python_client/mixins.py
 ./lago_python_client/py.typed
 ./lago_python_client/version.py
+./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/billable_metrics/__init__.py
 ./lago_python_client/billable_metrics/clients.py
+./lago_python_client/billing_entities/__init__.py
+./lago_python_client/billing_entities/clients.py
 ./lago_python_client/coupons/__init__.py
 ./lago_python_client/coupons/clients.py
 ./lago_python_client/credit_notes/__init__.py
@@ -34,9 +38,11 @@ setup.cfg
 ./lago_python_client/invoices/__init__.py
 ./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/applied_coupon.py
 ./lago_python_client/models/billable_metric.py
+./lago_python_client/models/billing_entity.py
 ./lago_python_client/models/billing_period.py
 ./lago_python_client/models/charge.py
 ./lago_python_client/models/coupon.py
@@ -96,9 +102,11 @@ setup.cfg
 ./lago_python_client/webhooks/__init__.py
 ./lago_python_client/webhooks/clients.py
 ./tests/__init__.py
+./tests/test_activity_logs_client.py
 ./tests/test_add_on_client.py
 ./tests/test_applied_coupon_client.py
 ./tests/test_billable_metric_client.py
+./tests/test_billing_entity_client.py
 ./tests/test_client.py
 ./tests/test_coupon_client.py
 ./tests/test_credit_note_client.py
@@ -140,10 +148,14 @@ lago_python_client.egg-info/SOURCES.txt
 lago_python_client.egg-info/dependency_links.txt
 lago_python_client.egg-info/requires.txt
 lago_python_client.egg-info/top_level.txt
+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/billable_metrics/__init__.py
 lago_python_client/billable_metrics/clients.py
+lago_python_client/billing_entities/__init__.py
+lago_python_client/billing_entities/clients.py
 lago_python_client/coupons/__init__.py
 lago_python_client/coupons/clients.py
 lago_python_client/credit_notes/__init__.py
@@ -163,9 +175,11 @@ lago_python_client/invoiced_usages/clients.py
 lago_python_client/invoices/__init__.py
 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/applied_coupon.py
 lago_python_client/models/billable_metric.py
+lago_python_client/models/billing_entity.py
 lago_python_client/models/billing_period.py
 lago_python_client/models/charge.py
 lago_python_client/models/coupon.py
@@ -225,9 +239,11 @@ lago_python_client/webhook_endpoints/clients.py
 lago_python_client/webhooks/__init__.py
 lago_python_client/webhooks/clients.py
 tests/__init__.py
+tests/test_activity_logs_client.py
 tests/test_add_on_client.py
 tests/test_applied_coupon_client.py
 tests/test_billable_metric_client.py
+tests/test_billing_entity_client.py
 tests/test_client.py
 tests/test_coupon_client.py
 tests/test_credit_note_client.py

lago_python_client-1.30.0/tests/test_activity_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/activity_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_activity_log_request(httpx_mock: HTTPXMock):
+    client = Client(api_key="886fe239-927d-4072-ab72-6dd345e8dd0d")
+    activity_id = "1262046f-ea6e-423b-8bf7-3a985232f91b"
+
+    httpx_mock.add_response(
+        method="GET",
+        url=ENDPOINT + f"/{activity_id}",
+        content=mock_response("fixtures/activity_log.json"),
+    )
+    response = client.activity_logs.find(activity_id)
+
+    assert response.activity_id == activity_id
+    assert response.activity_type == "billable_metric.created"
+
+
+def test_invalid_find_activity_log_request(httpx_mock: HTTPXMock):
+    client = Client(api_key="invalid")
+    activity_id = "invalid"
+
+    httpx_mock.add_response(
+        method="GET",
+        url=ENDPOINT + f"/{activity_id}",
+        status_code=404,
+        content=b"",
+    )
+
+    with pytest.raises(LagoApiError):
+        client.activity_logs.find(activity_id)
+
+
+def test_valid_find_all_activity_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/activity_log_index.json"),
+    )
+    response = client.activity_logs.find_all()
+
+    assert response["activity_logs"][0].activity_id == "1262046f-ea6e-423b-8bf7-3a985232f91b"
+    assert response["activity_logs"][1].activity_id == "6744ddec-3516-4e26-9c7e-dc3c30fc4e80"
+    assert response["meta"]["current_page"] == 1
+
+
+def test_valid_find_all_activity_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/activity_log_index.json"),
+    )
+    response = client.activity_logs.find_all(options)
+
+    assert response["activity_logs"][1].activity_id == "6744ddec-3516-4e26-9c7e-dc3c30fc4e80"
+    assert response["meta"]["current_page"] == 1
+
+
+def test_invalid_find_all_activity_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.activity_logs.find_all()
+
+
+def test_invalid_operations_for_activity_log_request():
+    client = Client(api_key="886fe239-927d-4072-ab72-6dd345e8dd0d")
+    assert not hasattr(client.activity_logs, "create")
+    assert not hasattr(client.activity_logs, "update")
+    assert not hasattr(client.activity_logs, "destroy")