lago-python-client 1.9.1__tar.gz → 1.11.0__tar.gz

{lago-python-client-1.9.1 → lago-python-client-1.11.0}/PKG-INFO

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

lago-python-client-1.11.0/lago_python_client/__init__.py

@@ -0,0 +1,2 @@
+from lago_python_client.client import Client as Client
+from lago_python_client.version import LAGO_VERSION as LAGO_VERSION

{lago-python-client-1.9.1 → lago-python-client-1.11.0}/lago_python_client/add_ons/clients.py

@@ -1,7 +1,13 @@
 from typing import ClassVar, Type
 
 from ..base_client import BaseClient
-from ..mixins import CreateCommandMixin, DestroyCommandMixin, FindAllCommandMixin, FindCommandMixin, UpdateCommandMixin
+from ..mixins import (
+    CreateCommandMixin,
+    DestroyCommandMixin,
+    FindAllCommandMixin,
+    FindCommandMixin,
+    UpdateCommandMixin,
+)
 from ..models.add_on import AddOnResponse
 
 
@@ -13,6 +19,6 @@ class AddOnClient(
     UpdateCommandMixin[AddOnResponse],
     BaseClient,
 ):
-    API_RESOURCE: ClassVar[str] = 'add_ons'
+    API_RESOURCE: ClassVar[str] = "add_ons"
     RESPONSE_MODEL: ClassVar[Type[AddOnResponse]] = AddOnResponse
-    ROOT_NAME: ClassVar[str] = 'add_on'
+    ROOT_NAME: ClassVar[str] = "add_on"

{lago-python-client-1.9.1 → lago-python-client-1.11.0}/lago_python_client/base_client.py

@@ -7,9 +7,10 @@ from lago_python_client.base_model import BaseModel
 class BaseClient(ABC):
     """The base class used for each collection client."""
 
-    def __init__(self, base_url: str, api_key: str):
+    def __init__(self, base_url: str, api_key: str, base_ingest_url: str = ""):
         self.base_url = base_url
         self.api_key = api_key
+        self.base_ingest_url = base_ingest_url
 
     @property
     @classmethod

lago-python-client-1.11.0/lago_python_client/billable_metrics/clients.py

@@ -0,0 +1,24 @@
+from typing import ClassVar, Type
+
+from ..base_client import BaseClient
+from ..mixins import (
+    CreateCommandMixin,
+    DestroyCommandMixin,
+    FindAllCommandMixin,
+    FindCommandMixin,
+    UpdateCommandMixin,
+)
+from ..models.billable_metric import BillableMetricResponse
+
+
+class BillableMetricClient(
+    CreateCommandMixin[BillableMetricResponse],
+    DestroyCommandMixin[BillableMetricResponse],
+    FindAllCommandMixin[BillableMetricResponse],
+    FindCommandMixin[BillableMetricResponse],
+    UpdateCommandMixin[BillableMetricResponse],
+    BaseClient,
+):
+    API_RESOURCE: ClassVar[str] = "billable_metrics"
+    RESPONSE_MODEL: ClassVar[Type[BillableMetricResponse]] = BillableMetricResponse
+    ROOT_NAME: ClassVar[str] = "billable_metric"

{lago-python-client-1.9.1 → lago-python-client-1.11.0}/lago_python_client/client.py

@@ -30,17 +30,34 @@ except ImportError:  # Python 3.7
 
 
 class Client:
-    BASE_URL: Final[str] = 'https://api.getlago.com/'
-    API_PATH: Final[str] = 'api/v1/'
+    BASE_URL: Final[str] = "https://api.getlago.com/"
+    BASE_INGEST_URL: Final[str] = "https://ingest.getlago.com/"
+    API_PATH: Final[str] = "api/v1/"
 
-    def __init__(self, api_key: str = '', api_url: str = '') -> None:
+    def __init__(
+        self, api_key: str = "", api_url: str = "", use_ingest_service: bool = False, ingest_api_url: str = ""
+    ) -> None:
         self.api_key: str = api_key
         self.api_url: str = api_url
+        self.use_ingest_service: bool = use_ingest_service
+        self.ingest_api_url: str = ingest_api_url
 
     @property
     def base_api_url(self) -> str:
         return urljoin(self.api_url if self.api_url else Client.BASE_URL, Client.API_PATH)
 
+    @property
+    def base_ingest_api_url(self) -> str:
+        if not self.use_ingest_service:
+            return self.base_api_url
+
+        if self.ingest_api_url == "":
+            ingest_url = Client.BASE_INGEST_URL
+        else:
+            ingest_url = self.ingest_api_url
+
+        return urljoin(ingest_url, Client.API_PATH)
+
     @callable_cached_property
     def add_ons(self) -> AddOnClient:
         return AddOnClient(self.base_api_url, self.api_key)
@@ -67,7 +84,7 @@ class Client:
 
     @callable_cached_property
     def events(self) -> EventClient:
-        return EventClient(self.base_api_url, self.api_key)
+        return EventClient(self.base_api_url, self.api_key, self.base_ingest_api_url)
 
     @callable_cached_property
     def fees(self) -> FeeClient:

{lago-python-client-1.9.1 → lago-python-client-1.11.0}/lago_python_client/coupons/clients.py

@@ -1,7 +1,13 @@
 from typing import ClassVar, Type
 
 from ..base_client import BaseClient
-from ..mixins import CreateCommandMixin, DestroyCommandMixin, FindAllCommandMixin, FindCommandMixin, UpdateCommandMixin
+from ..mixins import (
+    CreateCommandMixin,
+    DestroyCommandMixin,
+    FindAllCommandMixin,
+    FindCommandMixin,
+    UpdateCommandMixin,
+)
 from ..models.coupon import CouponResponse
 from ..models.applied_coupon import AppliedCouponResponse
 from ..services.request import make_headers, make_url, send_delete_request
@@ -16,21 +22,30 @@ class CouponClient(
     UpdateCommandMixin[CouponResponse],
     BaseClient,
 ):
-    API_RESOURCE: ClassVar[str] = 'coupons'
+    API_RESOURCE: ClassVar[str] = "coupons"
     RESPONSE_MODEL: ClassVar[Type[CouponResponse]] = CouponResponse
-    ROOT_NAME: ClassVar[str] = 'coupon'
+    ROOT_NAME: ClassVar[str] = "coupon"
 
 
-class AppliedCouponClient(CreateCommandMixin[AppliedCouponResponse], FindAllCommandMixin[AppliedCouponResponse], BaseClient):
-    API_RESOURCE: ClassVar[str] = 'applied_coupons'
+class AppliedCouponClient(
+    CreateCommandMixin[AppliedCouponResponse],
+    FindAllCommandMixin[AppliedCouponResponse],
+    BaseClient,
+):
+    API_RESOURCE: ClassVar[str] = "applied_coupons"
     RESPONSE_MODEL: ClassVar[Type[AppliedCouponResponse]] = AppliedCouponResponse
-    ROOT_NAME: ClassVar[str] = 'applied_coupon'
+    ROOT_NAME: ClassVar[str] = "applied_coupon"
 
     def destroy(self, external_customer_id: str, applied_coupon_id: str) -> AppliedCouponResponse:
         api_response: Response = send_delete_request(
             url=make_url(
                 origin=self.base_url,
-                path_parts=('customers', external_customer_id, self.API_RESOURCE, applied_coupon_id),
+                path_parts=(
+                    "customers",
+                    external_customer_id,
+                    self.API_RESOURCE,
+                    applied_coupon_id,
+                ),
             ),
             headers=make_headers(api_key=self.api_key),
         )

{lago-python-client-1.9.1 → lago-python-client-1.11.0}/lago_python_client/credit_notes/clients.py

@@ -1,10 +1,24 @@
-from typing import ClassVar, Optional, Type, Union
+from typing import ClassVar, Optional, Type
 
 from ..base_client import BaseClient
-from ..mixins import CreateCommandMixin, FindAllCommandMixin, FindCommandMixin, UpdateCommandMixin
-from ..models.credit_note import CreditNoteResponse, CreditNoteEstimatedResponse, CreditNoteEstimate
+from ..mixins import (
+    CreateCommandMixin,
+    FindAllCommandMixin,
+    FindCommandMixin,
+    UpdateCommandMixin,
+)
+from ..models.credit_note import (
+    CreditNoteResponse,
+    CreditNoteEstimatedResponse,
+    CreditNoteEstimate,
+)
 from ..services.json import to_json
-from ..services.request import make_headers, make_url, send_post_request, send_put_request
+from ..services.request import (
+    make_headers,
+    make_url,
+    send_post_request,
+    send_put_request,
+)
 from ..services.response import get_response_data, prepare_object_response, Response
 
 
@@ -15,16 +29,16 @@ class CreditNoteClient(
     UpdateCommandMixin[CreditNoteResponse],
     BaseClient,
 ):
-    API_RESOURCE: ClassVar[str] = 'credit_notes'
-    ESTIMATE_API_RESOURCE: ClassVar[str] = 'estimated_credit_note'
+    API_RESOURCE: ClassVar[str] = "credit_notes"
+    ESTIMATE_API_RESOURCE: ClassVar[str] = "estimated_credit_note"
     RESPONSE_MODEL: ClassVar[Type[CreditNoteResponse]] = CreditNoteResponse
-    ROOT_NAME: ClassVar[str] = 'credit_note'
+    ROOT_NAME: ClassVar[str] = "credit_note"
 
     def download(self, resource_id: str) -> Optional[CreditNoteResponse]:
         api_response: Response = send_post_request(
             url=make_url(
                 origin=self.base_url,
-                path_parts=(self.API_RESOURCE, resource_id, 'download'),
+                path_parts=(self.API_RESOURCE, resource_id, "download"),
             ),
             headers=make_headers(api_key=self.api_key),
         )
@@ -42,7 +56,7 @@ class CreditNoteClient(
         api_response: Response = send_put_request(
             url=make_url(
                 origin=self.base_url,
-                path_parts=(self.API_RESOURCE, resource_id, 'void'),
+                path_parts=(self.API_RESOURCE, resource_id, "void"),
             ),
             headers=make_headers(api_key=self.api_key),
         )
@@ -56,11 +70,13 @@ class CreditNoteClient(
         api_response: Response = send_post_request(
             url=make_url(
                 origin=self.base_url,
-                path_parts=(self.API_RESOURCE, 'estimate'),
+                path_parts=(self.API_RESOURCE, "estimate"),
+            ),
+            content=to_json(
+                {
+                    self.ROOT_NAME: input_object.dict(),
+                }
             ),
-            content=to_json({
-                self.ROOT_NAME: input_object.dict(),
-            }),
             headers=make_headers(api_key=self.api_key),
         )
 

{lago-python-client-1.9.1 → lago-python-client-1.11.0}/lago_python_client/customers/clients.py

@@ -2,11 +2,26 @@ import sys
 from typing import Any, Mapping, ClassVar, Type, Union
 
 from ..base_client import BaseClient
-from ..mixins import CreateCommandMixin, DestroyCommandMixin, FindAllCommandMixin, FindCommandMixin
+from ..mixins import (
+    CreateCommandMixin,
+    DestroyCommandMixin,
+    FindAllCommandMixin,
+    FindCommandMixin,
+)
 from ..models.customer import CustomerResponse
 from ..models.customer_usage import CustomerUsageResponse
-from ..services.request import make_headers, make_url, send_get_request, send_post_request
-from ..services.response import get_response_data, prepare_index_response, prepare_object_response, Response
+from ..services.request import (
+    make_headers,
+    make_url,
+    send_get_request,
+    send_post_request,
+)
+from ..services.response import (
+    get_response_data,
+    prepare_index_response,
+    prepare_object_response,
+    Response,
+)
 
 if sys.version_info >= (3, 9):
     from collections.abc import Mapping
@@ -21,17 +36,17 @@ class CustomerClient(
     FindCommandMixin[CustomerResponse],
     BaseClient,
 ):
-    API_RESOURCE: ClassVar[str] = 'customers'
+    API_RESOURCE: ClassVar[str] = "customers"
     RESPONSE_MODEL: ClassVar[Type[CustomerResponse]] = CustomerResponse
-    ROOT_NAME: ClassVar[str] = 'customer'
+    ROOT_NAME: ClassVar[str] = "customer"
 
     def current_usage(self, resource_id: str, external_subscription_id: str) -> CustomerUsageResponse:
         api_response: Response = send_get_request(
             url=make_url(
                 origin=self.base_url,
-                path_parts=(self.API_RESOURCE, resource_id, 'current_usage'),
+                path_parts=(self.API_RESOURCE, resource_id, "current_usage"),
                 query_pairs={
-                    'external_subscription_id': external_subscription_id,
+                    "external_subscription_id": external_subscription_id,
                 },
             ),
             headers=make_headers(api_key=self.api_key),
@@ -39,16 +54,21 @@ class CustomerClient(
 
         return prepare_object_response(
             response_model=CustomerUsageResponse,
-            data=get_response_data(response=api_response, key='customer_usage'),
+            data=get_response_data(response=api_response, key="customer_usage"),
         )
 
-    def past_usage(self, resource_id: str, external_subscription_id: str, options: Mapping[str, Union[int, str]] = {}) -> Mapping[str, Any]:
+    def past_usage(
+        self,
+        resource_id: str,
+        external_subscription_id: str,
+        options: Mapping[str, Union[int, str]] = {},
+    ) -> Mapping[str, Any]:
         api_response: Response = send_get_request(
             url=make_url(
                 origin=self.base_url,
-                path_parts=(self.API_RESOURCE, resource_id, 'past_usage'),
+                path_parts=(self.API_RESOURCE, resource_id, "past_usage"),
                 query_pairs={
-                    'external_subscription_id': external_subscription_id,
+                    "external_subscription_id": external_subscription_id,
                     **options,
                 },
             ),
@@ -56,32 +76,31 @@ class CustomerClient(
         )
 
         return prepare_index_response(
-            api_resource='usage_periods',
+            api_resource="usage_periods",
             response_model=CustomerUsageResponse,
             data=get_response_data(response=api_response),
         )
 
-
     def portal_url(self, resource_id: str) -> str:
         api_response: Response = send_get_request(
             url=make_url(
                 origin=self.base_url,
-                path_parts=(self.API_RESOURCE, resource_id, 'portal_url'),
+                path_parts=(self.API_RESOURCE, resource_id, "portal_url"),
             ),
             headers=make_headers(api_key=self.api_key),
         )
 
         response_data = get_response_data(response=api_response, key=self.ROOT_NAME)
-        return response_data.get('portal_url', '') if isinstance(response_data, Mapping) else ''
+        return response_data.get("portal_url", "") if isinstance(response_data, Mapping) else ""
 
     def checkout_url(self, resource_id: str) -> str:
         api_response: Response = send_post_request(
             url=make_url(
                 origin=self.base_url,
-                path_parts=(self.API_RESOURCE, resource_id, 'checkout_url'),
+                path_parts=(self.API_RESOURCE, resource_id, "checkout_url"),
             ),
             headers=make_headers(api_key=self.api_key),
         )
 
         response_data = get_response_data(response=api_response, key=self.ROOT_NAME)
-        return response_data.get('checkout_url', '') if isinstance(response_data, Mapping) else ''
+        return response_data.get("checkout_url", "") if isinstance(response_data, Mapping) else ""

lago-python-client-1.11.0/lago_python_client/events/clients.py

@@ -0,0 +1,90 @@
+import sys
+from typing import Any, ClassVar, Optional, Type
+
+import httpx
+
+from lago_python_client.base_model import BaseModel
+
+from ..base_client import BaseClient
+from ..fees.clients import FeeClient
+from ..mixins import FindCommandMixin
+from ..models.event import EventResponse
+from ..models.fee import FeeResponse
+from ..services.json import to_json
+from ..services.request import make_headers, make_url, send_post_request
+from ..services.response import (
+    get_response_data,
+    prepare_object_response,
+    prepare_object_list_response,
+    verify_response,
+    Response,
+)
+
+if sys.version_info >= (3, 9):
+    from collections.abc import Mapping
+else:
+    from typing import Mapping
+
+
+class EventClient(FindCommandMixin[EventResponse], BaseClient):
+    API_RESOURCE: ClassVar[str] = "events"
+    RESPONSE_MODEL: ClassVar[Type[EventResponse]] = EventResponse
+    ROOT_NAME: ClassVar[str] = "event"
+
+    def create(self, input_object: BaseModel, timeout: Optional[httpx.Timeout] = None) -> Optional[EventResponse]:
+        api_response: Response = send_post_request(
+            url=make_url(
+                origin=self.base_ingest_url,
+                path_parts=(self.API_RESOURCE,),
+            ),
+            content=to_json(
+                {
+                    self.ROOT_NAME: input_object.dict(),
+                }
+            ),
+            headers=make_headers(api_key=self.api_key),
+            timeout=timeout,
+        )
+
+        # Process response data
+        response_data = get_response_data(response=api_response, key=self.ROOT_NAME)
+        if not response_data:
+            return None
+
+        return prepare_object_response(
+            response_model=self.RESPONSE_MODEL,
+            data=response_data,
+        )
+
+    def batch_create(self, input_object: BaseModel) -> None:
+        api_response: Response = send_post_request(
+            url=make_url(
+                origin=self.base_url,
+                path_parts=(self.API_RESOURCE, "batch"),
+            ),
+            content=to_json(input_object.dict()),
+            headers=make_headers(api_key=self.api_key),
+        )
+        verify_response(api_response)
+
+        return None
+
+    def estimate_fees(self, input_object: BaseModel) -> Mapping[str, Any]:
+        api_response: Response = send_post_request(
+            url=make_url(
+                origin=self.base_url,
+                path_parts=(self.API_RESOURCE, "estimate_fees"),
+            ),
+            content=to_json(
+                {
+                    self.ROOT_NAME: input_object.dict(),
+                }
+            ),
+            headers=make_headers(api_key=self.api_key),
+        )
+
+        return prepare_object_list_response(
+            api_resource=FeeClient.API_RESOURCE,
+            response_model=FeeResponse,
+            data=get_response_data(response=api_response, key="fees"),
+        )

{lago-python-client-1.9.1 → lago-python-client-1.11.0}/lago_python_client/exceptions.py

@@ -24,7 +24,8 @@ class LagoApiError(Exception):
         self.response = response
         self.detail = detail
         self.headers = headers
+        super().__init__(self.response)
 
     def __repr__(self) -> str:
         class_name = self.__class__.__name__
-        return f"{class_name}(status_code={self.status_code!r}, detail={self.detail!r})"
+        return f"{class_name}(response={self.response!r}"

{lago-python-client-1.9.1 → lago-python-client-1.11.0}/lago_python_client/fees/clients.py

@@ -1,7 +1,12 @@
 from typing import ClassVar, Type
 
 from ..base_client import BaseClient
-from ..mixins import FindCommandMixin, FindAllCommandMixin, UpdateCommandMixin, DestroyCommandMixin
+from ..mixins import (
+    FindCommandMixin,
+    FindAllCommandMixin,
+    UpdateCommandMixin,
+    DestroyCommandMixin,
+)
 from ..models.fee import FeeResponse
 
 
@@ -12,6 +17,6 @@ class FeeClient(
     DestroyCommandMixin[FeeResponse],
     BaseClient,
 ):
-    API_RESOURCE: ClassVar[str] = 'fees'
+    API_RESOURCE: ClassVar[str] = "fees"
     RESPONSE_MODEL: ClassVar[Type[FeeResponse]] = FeeResponse
-    ROOT_NAME: ClassVar[str] = 'fee'
+    ROOT_NAME: ClassVar[str] = "fee"

{lago-python-client-1.9.1 → lago-python-client-1.11.0}/lago_python_client/functools_ext.py

@@ -1,6 +1,7 @@
 import sys
 from typing import Any, TypeVar
 import warnings
+
 try:
     from functools import cached_property
 except ImportError:
@@ -30,11 +31,13 @@ class Proxy(object):
 
     def __call__(self) -> Any:
         warnings.warn(
-            ''.join((
-                'We are going to deprecate callable properties (`client.<your_tag_name>()`) in future. ',
-                'Please, remove braces. ',
-                'Use `client.<your_tag_name>.<your_operation_name>(...)` instead of `client.<your_tag_name>().<your_operation_name>(...)`',
-            )),
+            "".join(
+                (
+                    "We are going to deprecate callable properties (`client.<your_tag_name>()`) in future. ",
+                    "Please, remove braces. ",
+                    "Use `client.<your_tag_name>.<your_operation_name>(...)` instead of `client.<your_tag_name>().<your_operation_name>(...)`",
+                )
+            ),
             PendingDeprecationWarning,
         )
         return self._obj
@@ -53,8 +56,10 @@ class Proxy(object):
 
 
 if sys.version_info >= (3, 9):
+
     def callable_cached_property(func: Callable[P, T]) -> cached_property[T]:
         return cached_property(lambda s: Proxy(func(s)))  # type: ignore
 else:
+
     def callable_cached_property(func):
         return cached_property(lambda s: Proxy(func(s)))

{lago-python-client-1.9.1 → lago-python-client-1.11.0}/lago_python_client/gross_revenues/clients.py

@@ -17,15 +17,15 @@ class GrossRevenueClient(
     FindAllCommandMixin[GrossRevenueResponse],
     BaseClient,
 ):
-    API_RESOURCE: ClassVar[str] = 'gross_revenues'
+    API_RESOURCE: ClassVar[str] = "gross_revenues"
     RESPONSE_MODEL: ClassVar[Type[GrossRevenueResponse]] = GrossRevenueResponse
-    ROOT_NAME: ClassVar[str] = 'gross_revenue'
+    ROOT_NAME: ClassVar[str] = "gross_revenue"
 
     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', 'gross_revenue'),
+                path_parts=("analytics", "gross_revenue"),
                 query_pairs=options,
             ),
             headers=make_headers(api_key=self.api_key),

{lago-python-client-1.9.1 → lago-python-client-1.11.0}/lago_python_client/invoice_collections/clients.py

@@ -17,15 +17,15 @@ class InvoiceCollectionClient(
     FindAllCommandMixin[InvoiceCollectionResponse],
     BaseClient,
 ):
-    API_RESOURCE: ClassVar[str] = 'invoice_collections'
+    API_RESOURCE: ClassVar[str] = "invoice_collections"
     RESPONSE_MODEL: ClassVar[Type[InvoiceCollectionResponse]] = InvoiceCollectionResponse
-    ROOT_NAME: ClassVar[str] = 'invoice_collection'
+    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', 'invoice_collection'),
+                path_parts=("analytics", "invoice_collection"),
                 query_pairs=options,
             ),
             headers=make_headers(api_key=self.api_key),

{lago-python-client-1.9.1 → lago-python-client-1.11.0}/lago_python_client/invoiced_usages/clients.py

@@ -17,15 +17,15 @@ class InvoicedUsageClient(
     FindAllCommandMixin[InvoicedUsageResponse],
     BaseClient,
 ):
-    API_RESOURCE: ClassVar[str] = 'invoiced_usages'
+    API_RESOURCE: ClassVar[str] = "invoiced_usages"
     RESPONSE_MODEL: ClassVar[Type[InvoicedUsageResponse]] = InvoicedUsageResponse
-    ROOT_NAME: ClassVar[str] = 'invoiced_usage'
+    ROOT_NAME: ClassVar[str] = "invoiced_usage"
 
     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', 'invoiced_usage'),
+                path_parts=("analytics", "invoiced_usage"),
                 query_pairs=options,
             ),
             headers=make_headers(api_key=self.api_key),