lago-python-client 1.26.0__tar.gz → 1.28.1__tar.gz

{lago_python_client-1.26.0 → lago_python_client-1.28.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: lago-python-client
-Version: 1.26.0
+Version: 1.28.1
 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.26.0 → lago_python_client-1.28.1}/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.28.1/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.26.0 → lago_python_client-1.28.1}/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
@@ -68,6 +69,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)

{lago_python_client-1.26.0 → lago_python_client-1.28.1}/lago_python_client/models/__init__.py

@@ -7,6 +7,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,

lago_python_client-1.28.1/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.26.0 → lago_python_client-1.28.1}/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.28.1/lago_python_client/version.py

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

{lago_python_client-1.26.0 → lago_python_client-1.28.1}/lago_python_client.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: lago-python-client
-Version: 1.26.0
+Version: 1.28.1
 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.26.0 → lago_python_client-1.28.1}/lago_python_client.egg-info/SOURCES.txt

@@ -15,6 +15,8 @@ setup.cfg
 ./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
@@ -37,6 +39,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_entity.py
 ./lago_python_client/models/billing_period.py
 ./lago_python_client/models/charge.py
 ./lago_python_client/models/coupon.py
@@ -99,6 +102,7 @@ setup.cfg
 ./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
@@ -144,6 +148,8 @@ 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
@@ -166,6 +172,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_entity.py
 lago_python_client/models/billing_period.py
 lago_python_client/models/charge.py
 lago_python_client/models/coupon.py
@@ -228,6 +235,7 @@ tests/__init__.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.28.1/tests/test_billing_entity_client.py

@@ -0,0 +1,201 @@
+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 BillingEntity, BillingEntityUpdate, BillingEntityBillingConfiguration
+
+
+def mock_response(mock="billing_entity"):
+    this_dir = os.path.dirname(os.path.abspath(__file__))
+    my_data_path = os.path.join(this_dir, "fixtures/" + mock + ".json")
+
+    with open(my_data_path, "rb") as billing_entity_response:
+        return billing_entity_response.read()
+
+
+def create_billing_entity_input():
+    return BillingEntity(
+        name="Test Company",
+        code="test-company",
+        address_line1="123 Test Street",
+        address_line2="Suite 100",
+        city="Test City",
+        state="TS",
+        zipcode="12345",
+        country="US",
+        email="test@company.com",
+        phone="+1234567890",
+        default_currency="USD",
+        timezone="UTC",
+        document_numbering="per_customer",
+        document_number_prefix="TEST-",
+        finalize_zero_amount_invoice=True,
+        net_payment_term=30,
+        eu_tax_management=False,
+        logo="=base64 encoded file",
+        legal_name="Test Company Legal Name",
+        legal_number="123456789",
+        tax_identification_number="TAX123456",
+        email_settings=["invoice.finalized", "payment_receipt.created"],
+        billing_configuration=BillingEntityBillingConfiguration(
+            invoice_footer="Thank you for your business",
+            invoice_grace_period=3,
+            document_locale="en",
+        ),
+    )
+
+
+def update_billing_entity_input():
+    return BillingEntityUpdate(
+        name="Updated Company Name",
+        address_line1="456 Test Avenue",
+        address_line2="Suite 200",
+        city="Updated City",
+        state="Greater Paris",
+        zipcode="54321",
+        country="FR",
+        email="updated@company.com",
+        phone="+1987654321",
+        default_currency="EUR",
+        timezone="UTC",
+        document_numbering="per_billing_entity",
+        document_number_prefix="UPD-",
+        finalize_zero_amount_invoice=True,
+        net_payment_term=15,
+        eu_tax_management=True,
+        logo="=base 64 encoded file",
+        legal_name="Updated Company Legal Name",
+        legal_number="987654321",
+        tax_identification_number="TAX654321",
+        tax_codes=["VAT-01", "VAT-25"],
+        email_settings=["invoice.finalized"],
+        billing_configuration=BillingEntityBillingConfiguration(
+            invoice_footer="Updated footer",
+            invoice_grace_period=5,
+            document_locale="fr",
+        ),
+    )
+
+
+def test_valid_create_billing_entity_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/billing_entities",
+        content=mock_response(),
+    )
+    response = client.billing_entities.create(create_billing_entity_input())
+
+    assert response is not None
+    assert response.lago_id == "123e4567-e89b-12d3-a456-426614174000"
+    assert response.code == "test-company"
+
+
+def test_invalid_create_billing_entity_request(httpx_mock: HTTPXMock):
+    client = Client(api_key="invalid")
+
+    httpx_mock.add_response(
+        method="POST",
+        url="https://api.getlago.com/api/v1/billing_entities",
+        status_code=401,
+        content=b"",
+    )
+
+    with pytest.raises(LagoApiError):
+        client.billing_entities.create(create_billing_entity_input())
+
+
+def test_valid_find_billing_entity_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/billing_entities/test-company",
+        content=mock_response(),
+    )
+    response = client.billing_entities.find("test-company")
+
+    assert response is not None
+    assert response.lago_id == "123e4567-e89b-12d3-a456-426614174000"
+    assert response.code == "test-company"
+
+
+def test_invalid_find_billing_entity_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/billing_entities/invalid-code",
+        status_code=404,
+        content=b"",
+    )
+
+    with pytest.raises(LagoApiError):
+        client.billing_entities.find("invalid-code")
+
+
+def test_valid_find_all_billing_entities_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/billing_entities",
+        content=mock_response("billing_entity_index"),
+    )
+    response = client.billing_entities.find_all()
+
+    assert len(response["billing_entities"]) == 2
+    assert response["meta"]["current_page"] == 1
+
+    assert response["billing_entities"][0].lago_id == "123e4567-e89b-12d3-a456-426614174000"
+    assert response["billing_entities"][0].code == "test-company-1"
+    assert response["billing_entities"][1].lago_id == "123e4567-e89b-12d3-a456-426614174001"
+    assert response["billing_entities"][1].code == "test-company-2"
+
+
+def test_invalid_find_all_billing_entities_request(httpx_mock: HTTPXMock):
+    client = Client(api_key="invalid")
+
+    httpx_mock.add_response(
+        method="GET",
+        url="https://api.getlago.com/api/v1/billing_entities",
+        status_code=401,
+        content=b"",
+    )
+
+    with pytest.raises(LagoApiError):
+        client.billing_entities.find_all()
+
+
+def test_valid_update_billing_entity_request(httpx_mock: HTTPXMock):
+    client = Client(api_key="886fe239-927d-4072-ab72-6dd345e8dd0d")
+    billing_entity_code = "test-company"
+
+    httpx_mock.add_response(
+        method="PUT",
+        url="https://api.getlago.com/api/v1/billing_entities/" + billing_entity_code,
+        content=mock_response(),
+    )
+    response = client.billing_entities.update(update_billing_entity_input(), billing_entity_code)
+
+    assert response.lago_id == "123e4567-e89b-12d3-a456-426614174000"
+    assert response.code == "test-company"
+
+
+def test_invalid_update_billing_entity_request(httpx_mock: HTTPXMock):
+    client = Client(api_key="invalid")
+    billing_entity_code = "test-company"
+
+    httpx_mock.add_response(
+        method="PUT",
+        url="https://api.getlago.com/api/v1/billing_entities/" + billing_entity_code,
+        status_code=401,
+        content=b"",
+    )
+
+    with pytest.raises(LagoApiError):
+        client.billing_entities.update(update_billing_entity_input(), billing_entity_code)

lago_python_client-1.26.0/lago_python_client/version.py

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