lago-python-client 0.52.1__tar.gz → 0.55.0__tar.gz

{lago-python-client-0.52.1 → lago-python-client-0.55.0}/PKG-INFO

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

{lago-python-client-0.52.1 → lago-python-client-0.55.0}/lago_python_client/client.py

@@ -13,7 +13,7 @@ from .invoices.clients import InvoiceClient
 from .invoiced_usages.clients import InvoicedUsageClient
 from .mrrs.clients import MrrClient
 from .organizations.clients import OrganizationClient
-from .outstanding_invoices.clients import OutstandingInvoiceClient
+from .invoice_collections.clients import InvoiceCollectionClient
 from .plans.clients import PlanClient
 from .subscriptions.clients import SubscriptionClient
 from .taxes.clients import TaxClient
@@ -96,8 +96,8 @@ class Client:
         return OrganizationClient(self.base_api_url, self.api_key)
 
     @callable_cached_property
-    def outstanding_invoices(self) -> OutstandingInvoiceClient:
-        return OutstandingInvoiceClient(self.base_api_url, self.api_key)
+    def invoice_collections(self) -> InvoiceCollectionClient:
+        return InvoiceCollectionClient(self.base_api_url, self.api_key)
 
     @callable_cached_property
     def plans(self) -> PlanClient:

{lago-python-client-0.52.1 → lago-python-client-0.55.0}/lago_python_client/events/clients.py

@@ -29,9 +29,7 @@ class EventClient(CreateCommandMixin[EventResponse], FindCommandMixin[EventRespo
                 origin=self.base_url,
                 path_parts=(self.API_RESOURCE, 'batch'),
             ),
-            content=to_json({
-                self.ROOT_NAME: input_object.dict(),
-            }),
+            content=to_json(input_object.dict()),
             headers=make_headers(api_key=self.api_key),
         )
         verify_response(api_response)

{lago-python-client-0.52.1/lago_python_client/outstanding_invoices → lago-python-client-0.55.0/lago_python_client/invoice_collections}/clients.py

@@ -3,7 +3,7 @@ from typing import Any, ClassVar, Type, Union
 
 from ..base_client import BaseClient
 from ..mixins import FindAllCommandMixin
-from ..models.outstanding_invoice import OutstandingInvoiceResponse
+from ..models.invoice_collection import InvoiceCollectionResponse
 from ..services.request import make_headers, make_url, send_get_request
 from ..services.response import get_response_data, prepare_index_response, Response
 
@@ -13,19 +13,19 @@ else:
     from typing import Mapping
 
 
-class OutstandingInvoiceClient(
-    FindAllCommandMixin[OutstandingInvoiceResponse],
+class InvoiceCollectionClient(
+    FindAllCommandMixin[InvoiceCollectionResponse],
     BaseClient,
 ):
-    API_RESOURCE: ClassVar[str] = 'outstanding_invoices'
-    RESPONSE_MODEL: ClassVar[Type[OutstandingInvoiceResponse]] = OutstandingInvoiceResponse
-    ROOT_NAME: ClassVar[str] = 'outstanding_invoice'
+    API_RESOURCE: ClassVar[str] = 'invoice_collections'
+    RESPONSE_MODEL: ClassVar[Type[InvoiceCollectionResponse]] = InvoiceCollectionResponse
+    ROOT_NAME: ClassVar[str] = 'invoice_collection'
 
     def find_all(self, options: Mapping[str, Union[int, str]] = {}) -> Mapping[str, Any]:
         api_response: Response = send_get_request(
             url=make_url(
                 origin=self.base_url,
-                path_parts=('analytics', self.API_RESOURCE),
+                path_parts=('analytics', 'invoice_collection'),
                 query_pairs=options,
             ),
             headers=make_headers(api_key=self.api_key),

{lago-python-client-0.52.1 → lago-python-client-0.55.0}/lago_python_client/models/__init__.py

@@ -17,6 +17,7 @@ from .invoice_item import InvoiceItemResponse
 from .subscription import Subscription
 from .customer_usage import Metric, ChargeObject, ChargeUsage, CustomerUsageResponse
 from .tax import Tax, Taxes, TaxResponse, TaxesResponse
-from .wallet import Wallet
+from .wallet import Wallet, RecurringTransactionRule, RecurringTransactionRuleList, \
+    RecurringTransactionRuleResponse, RecurringTransactionRuleResponseList
 from .wallet_transaction import WalletTransaction
 from .webhook_endpoint import WebhookEndpoint

{lago-python-client-0.52.1 → lago-python-client-0.55.0}/lago_python_client/models/customer.py

@@ -10,6 +10,7 @@ from .tax import TaxesResponse
 class CustomerBillingConfiguration(BaseModel):
     invoice_grace_period: Optional[int]
     payment_provider: Optional[str]
+    payment_provider_code: Optional[str]
     provider_customer_id: Optional[str]
     sync: Optional[bool]
     sync_with_provider: Optional[bool]

{lago-python-client-0.52.1 → lago-python-client-0.55.0}/lago_python_client/models/event.py

@@ -15,13 +15,7 @@ class Event(BaseModel):
 
 
 class BatchEvent(BaseModel):
-    transaction_id: str
-    external_customer_id: Optional[str]
-    external_subscription_ids: List[str]
-    code: str
-    timestamp: Optional[Union[int, str]]
-    properties: Optional[Dict[str, Any]]
-
+    events: List[Event]
 
 class EventResponse(BaseResponseModel):
     lago_id: str
@@ -34,3 +28,6 @@ class EventResponse(BaseResponseModel):
     timestamp: str
     properties: Optional[Dict[str, Any]]
     created_at: str
+
+class BatchEventResponse(BaseResponseModel):
+    events: List[EventResponse]

{lago-python-client-0.52.1 → lago-python-client-0.55.0}/lago_python_client/models/fee.py

@@ -1,4 +1,4 @@
-from typing import List, Optional
+from typing import Any, Dict, List, Optional
 
 from .invoice_item import InvoiceItemResponse
 from ..base_model import BaseModel, BaseResponseModel
@@ -38,7 +38,7 @@ class FeeResponse(BaseResponseModel):
     taxes_rate: Optional[float]
     total_amount_cents: Optional[int]
     unit_amount_cents: Optional[int] # deprecated
-    precise_unit_amount: Optional[float]
+    precise_unit_amount: Optional[str]
     total_amount_currency: Optional[str]
     units: Optional[float]
     events_count: Optional[int]
@@ -53,6 +53,7 @@ class FeeResponse(BaseResponseModel):
     refunded_at: Optional[str]
     from_date: Optional[str]
     to_date: Optional[str]
+    amount_details: Optional[Dict[str, Any]]
 
     item: Optional[InvoiceItemResponse]
     applied_taxes: Optional[FeeAppliedTaxes]

lago-python-client-0.52.1/lago_python_client/models/outstanding_invoice.py → lago-python-client-0.55.0/lago_python_client/models/invoice_collection.py

@@ -3,7 +3,7 @@ from typing import List, Optional
 from ..base_model import BaseModel, BaseResponseModel
 
 
-class OutstandingInvoiceResponse(BaseResponseModel):
+class InvoiceCollectionResponse(BaseResponseModel):
     amount_cents: int
     currency: Optional[str]
     month: str
@@ -11,5 +11,5 @@ class OutstandingInvoiceResponse(BaseResponseModel):
     payment_status: Optional[str]
 
 
-class OutstandingInvoicesResponse(BaseResponseModel):
-    __root__: List[OutstandingInvoiceResponse]
+class InvoiceCollectionsResponse(BaseResponseModel):
+    __root__: List[InvoiceCollectionResponse]

{lago-python-client-0.52.1 → lago-python-client-0.55.0}/lago_python_client/models/organization.py

@@ -25,6 +25,8 @@ class Organization(BaseModel):
     city: Optional[str]
     legal_name: Optional[str]
     legal_number: Optional[str]
+    document_numbering: Optional[str]
+    document_number_prefix: Optional[str]
     net_payment_term: Optional[int]
     tax_identification_number: Optional[str]
     timezone: Optional[str]
@@ -47,6 +49,8 @@ class OrganizationResponse(BaseResponseModel):
     legal_name: Optional[str]
     legal_number: Optional[str]
     net_payment_term: Optional[int]
+    document_numbering: Optional[str]
+    document_number_prefix: Optional[str]
     tax_identification_number: Optional[str]
     timezone: Optional[str]
     email_settings: Optional[List[str]]

lago-python-client-0.55.0/lago_python_client/models/wallet.py

@@ -0,0 +1,67 @@
+from typing import List, Optional
+
+from pydantic import BaseModel
+
+from ..base_model import BaseResponseModel
+
+
+class RecurringTransactionRule(BaseModel):
+    lago_id: Optional[str]
+    rule_type: Optional[str]
+    interval: Optional[str]
+    threshold_credits: Optional[str]
+    paid_credits: Optional[str]
+    granted_credits: Optional[str]
+
+
+class RecurringTransactionRuleResponse(BaseModel):
+    lago_id: Optional[str]
+    rule_type: Optional[str]
+    interval: Optional[str]
+    threshold_credits: Optional[str]
+    paid_credits: Optional[str]
+    granted_credits: Optional[str]
+    created_at: Optional[str]
+
+
+class RecurringTransactionRuleList(BaseModel):
+    __root__: List[RecurringTransactionRule]
+
+
+class RecurringTransactionRuleResponseList(BaseModel):
+    __root__: List[RecurringTransactionRuleResponse]
+
+
+class Wallet(BaseModel):
+    external_customer_id: Optional[str]
+    rate_amount: Optional[str]
+    name: Optional[str]
+    paid_credits: Optional[str]
+    granted_credits: Optional[str]
+    expiration_at: Optional[str]
+    currency: Optional[str]
+    recurring_transaction_rules: Optional[RecurringTransactionRuleList]
+
+
+class WalletResponse(BaseResponseModel):
+    lago_id: str
+    lago_customer_id: str
+    external_customer_id: str
+    status: str
+    currency: str
+    name: Optional[str]
+    rate_amount: str
+    credits_balance: str
+    balance_cents: int
+    consumed_credits: str
+    created_at: str
+    expiration_at: Optional[str]
+    last_balance_sync_at: Optional[str]
+    last_consumed_credit_at: Optional[str]
+    terminated_at: Optional[str]
+    recurring_transaction_rules: Optional[RecurringTransactionRuleResponseList]
+    ongoing_balance_cents: int
+    ongoing_usage_balance_cents: int
+    credits_ongoing_balance: str
+    credits_ongoing_usage_balance: str
+    balance: str # NOTE(legacy)

lago-python-client-0.55.0/lago_python_client/version.py

@@ -0,0 +1 @@
+LAGO_VERSION = '0.55.0'

{lago-python-client-0.52.1 → lago-python-client-0.55.0}/lago_python_client.egg-info/PKG-INFO

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

{lago-python-client-0.52.1 → lago-python-client-0.55.0}/lago_python_client.egg-info/SOURCES.txt

@@ -27,6 +27,8 @@ setup.cfg
 ./lago_python_client/fees/clients.py
 ./lago_python_client/gross_revenues/__init__.py
 ./lago_python_client/gross_revenues/clients.py
+./lago_python_client/invoice_collections/__init__.py
+./lago_python_client/invoice_collections/clients.py
 ./lago_python_client/invoiced_usages/__init__.py
 ./lago_python_client/invoiced_usages/clients.py
 ./lago_python_client/invoices/__init__.py
@@ -46,11 +48,11 @@ setup.cfg
 ./lago_python_client/models/gross_revenue.py
 ./lago_python_client/models/group.py
 ./lago_python_client/models/invoice.py
+./lago_python_client/models/invoice_collection.py
 ./lago_python_client/models/invoice_item.py
 ./lago_python_client/models/invoiced_usage.py
 ./lago_python_client/models/mrr.py
 ./lago_python_client/models/organization.py
-./lago_python_client/models/outstanding_invoice.py
 ./lago_python_client/models/plan.py
 ./lago_python_client/models/subscription.py
 ./lago_python_client/models/tax.py
@@ -61,8 +63,6 @@ setup.cfg
 ./lago_python_client/mrrs/clients.py
 ./lago_python_client/organizations/__init__.py
 ./lago_python_client/organizations/clients.py
-./lago_python_client/outstanding_invoices/__init__.py
-./lago_python_client/outstanding_invoices/clients.py
 ./lago_python_client/plans/__init__.py
 ./lago_python_client/plans/clients.py
 ./lago_python_client/services/__init__.py
@@ -93,11 +93,11 @@ setup.cfg
 ./tests/test_gross_revenue_client.py
 ./tests/test_group_client.py
 ./tests/test_invoice_client.py
+./tests/test_invoice_collection_client.py
 ./tests/test_invoiced_usage_client.py
 ./tests/test_json_services.py
 ./tests/test_mrr_client.py
 ./tests/test_organization_client.py
-./tests/test_outstanding_invoices_client.py
 ./tests/test_plan_client.py
 ./tests/test_request_services.py
 ./tests/test_response_services.py
@@ -125,11 +125,11 @@ tests/test_functools_ext.py
 tests/test_gross_revenue_client.py
 tests/test_group_client.py
 tests/test_invoice_client.py
+tests/test_invoice_collection_client.py
 tests/test_invoiced_usage_client.py
 tests/test_json_services.py
 tests/test_mrr_client.py
 tests/test_organization_client.py
-tests/test_outstanding_invoices_client.py
 tests/test_plan_client.py
 tests/test_request_services.py
 tests/test_response_services.py

{lago-python-client-0.52.1 → lago-python-client-0.55.0}/tests/test_customer_client.py

@@ -25,6 +25,7 @@ def create_customer():
         billing_configuration=CustomerBillingConfiguration(
             invoice_grace_period=3,
             payment_provider='stripe',
+            payment_provider_code='stripe-eu-1',
             provider_customer_id='cus_12345',
             sync_with_provider=True,
             document_locale="fr",
@@ -56,6 +57,7 @@ def test_valid_create_customers_request(httpx_mock: HTTPXMock):
     assert response.net_payment_term == None
     assert response.billing_configuration.invoice_grace_period == 3
     assert response.billing_configuration.payment_provider == 'stripe'
+    assert response.billing_configuration.payment_provider_code == 'stripe-eu-1'
     assert response.billing_configuration.provider_customer_id == 'cus_12345'
     assert response.billing_configuration.sync_with_provider == True
     assert response.billing_configuration.document_locale == "fr"

{lago-python-client-0.52.1 → lago-python-client-0.55.0}/tests/test_event_client.py

@@ -17,7 +17,11 @@ def create_event_with_string_timestamp():
 
 
 def create_batch_event():
-    return BatchEvent(external_subscription_ids=['88u02857-a71e-4ea2-bcf9-57d8885990ba'], code='123', transaction_id='123')
+    return BatchEvent(
+        events=[
+            Event(external_customer_id='5eb02857-a71e-4ea2-bcf9-57d8885990ba', code='123', transaction_id='123'),
+        ],
+    )
 
 
 def mock_response():

{lago-python-client-0.52.1 → lago-python-client-0.55.0}/tests/test_invoice_client.py

@@ -53,8 +53,9 @@ def test_valid_create_invoice_request(httpx_mock: HTTPXMock):
     assert response.lago_id == '5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba'
     assert response.invoice_type == 'one_off'
     assert response.fees.__root__[0].invoice_display_name == 'fee_invoice_display_name'
-    assert response.fees.__root__[0].precise_unit_amount == 9.52
+    assert response.fees.__root__[0].precise_unit_amount == '9.52'
     assert response.fees.__root__[0].item.invoice_display_name == 'one_off_invoice_display_name'
+    assert response.fees.__root__[0].amount_details == {}
 
 
 def test_invalid_create_invoice_request(httpx_mock: HTTPXMock):

lago-python-client-0.55.0/tests/test_invoice_collection_client.py

@@ -0,0 +1,29 @@
+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.invoice_collection import InvoiceCollectionResponse
+
+
+def mock_collection_response():
+    current_dir = os.path.dirname(os.path.abspath(__file__))
+    data_path = os.path.join(current_dir, 'fixtures/invoice_collection_index.json')
+
+    with open(data_path, 'rb') as invoice_collections_response:
+        return invoice_collections_response.read()
+
+
+def test_valid_find_all_invoice_collections_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/analytics/invoice_collection', content=mock_collection_response())
+    response = client.invoice_collections.find_all()
+
+    assert response['invoice_collections'][0].currency == 'EUR'
+    assert response['invoice_collections'][0].amount_cents == 100
+    assert response['invoice_collections'][0].month == '2023-11-01T00:00:00.000Z'
+    assert response['invoice_collections'][0].invoices_count == 10
+    assert response['invoice_collections'][0].payment_status == 'pending'

{lago-python-client-0.52.1 → lago-python-client-0.55.0}/tests/test_organization_client.py

@@ -15,6 +15,7 @@ def organization_object():
         tax_identification_number='EU123456789',
         net_payment_term=0,
         default_currency='EUR',
+        document_number_prefix='ORG-1234',
         billing_configuration=OrganizationBillingConfiguration(
             invoice_footer='footer',
             invoice_grace_period=3,
@@ -40,6 +41,7 @@ def test_valid_update_organization_request(httpx_mock: HTTPXMock):
 
     assert response.name == 'Hooli'
     assert response.tax_identification_number == 'EU123456789'
+    assert response.document_number_prefix == 'ORG-1234'
     assert response.net_payment_term == 0
 
 

{lago-python-client-0.52.1 → lago-python-client-0.55.0}/tests/test_wallet_client.py

@@ -5,16 +5,24 @@ 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 Wallet
+from lago_python_client.models import Wallet, RecurringTransactionRule, RecurringTransactionRuleList
 
 
 def wallet_object():
+    rule = RecurringTransactionRule(
+        rule_type='interval',
+        interval='monthly',
+        paid_credits='105.0',
+        granted_credits='105.0',
+    )
+    rules_list = RecurringTransactionRuleList(__root__=[rule])
     return Wallet(
         name='name',
         external_customer_id='12345',
         rate_amount='1',
         paid_credits='10',
-        granted_credits='10'
+        granted_credits='10',
+        recurring_transaction_rules=rules_list
     )
 
 
@@ -41,6 +49,9 @@ def test_valid_create_wallet_request(httpx_mock: HTTPXMock):
     response = client.wallets.create(wallet_object())
 
     assert response.lago_id == 'b7ab2926-1de8-4428-9bcd-779314ac129b'
+    assert response.recurring_transaction_rules.__root__[0].lago_id == '12345'
+    assert response.recurring_transaction_rules.__root__[0].rule_type == 'interval'
+    assert response.recurring_transaction_rules.__root__[0].interval == 'monthly'
 
 
 def test_invalid_create_wallet_request(httpx_mock: HTTPXMock):

lago-python-client-0.52.1/lago_python_client/models/wallet.py

@@ -1,34 +0,0 @@
-from typing import Optional
-
-from pydantic import BaseModel
-
-from ..base_model import BaseResponseModel
-
-
-class Wallet(BaseModel):
-    external_customer_id: Optional[str]
-    rate_amount: Optional[str]
-    name: Optional[str]
-    paid_credits: Optional[str]
-    granted_credits: Optional[str]
-    expiration_at: Optional[str]
-    currency: Optional[str]
-
-
-class WalletResponse(BaseResponseModel):
-    lago_id: str
-    lago_customer_id: str
-    external_customer_id: str
-    status: str
-    currency: str
-    name: Optional[str]
-    rate_amount: str
-    credits_balance: str
-    balance_cents: int
-    consumed_credits: str
-    created_at: str
-    expiration_at: Optional[str]
-    last_balance_sync_at: Optional[str]
-    last_consumed_credit_at: Optional[str]
-    terminated_at: Optional[str]
-    balance: str # NOTE(legacy)

lago-python-client-0.52.1/lago_python_client/version.py

@@ -1 +0,0 @@
-LAGO_VERSION = '0.52.1'

lago-python-client-0.52.1/tests/test_outstanding_invoices_client.py

@@ -1,29 +0,0 @@
-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.outstanding_invoice import OutstandingInvoiceResponse
-
-
-def mock_collection_response():
-    current_dir = os.path.dirname(os.path.abspath(__file__))
-    data_path = os.path.join(current_dir, 'fixtures/outstanding_invoice_index.json')
-
-    with open(data_path, 'rb') as outstanding_invoices_response:
-        return outstanding_invoices_response.read()
-
-
-def test_valid_find_all_outstanding_invoices_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/analytics/outstanding_invoices', content=mock_collection_response())
-    response = client.outstanding_invoices.find_all()
-
-    assert response['outstanding_invoices'][0].currency == 'EUR'
-    assert response['outstanding_invoices'][0].amount_cents == 100
-    assert response['outstanding_invoices'][0].month == '2023-11-01T00:00:00.000Z'
-    assert response['outstanding_invoices'][0].invoices_count == 10
-    assert response['outstanding_invoices'][0].payment_status == 'pending'