lark-billing 0.0.8__py3-none-any.whl → 0.1.0__py3-none-any.whl

lark/types/pricing_metric_resource.py

@@ -8,11 +8,30 @@ from .aggregation import Aggregation
 
 
 class PricingMetricResource(UniversalBaseModel):
-    id: str
-    name: str
-    event_name: str
-    aggregation: Aggregation
-    unit: str
+    id: str = pydantic.Field()
+    """
+    The ID of the pricing metric.
+    """
+
+    name: str = pydantic.Field()
+    """
+    The name of the pricing metric.
+    """
+
+    event_name: str = pydantic.Field()
+    """
+    The event name that the pricing metric is computed on.
+    """
+
+    aggregation: Aggregation = pydantic.Field()
+    """
+    The aggregation function used to compute the value of the pricing metric.
+    """
+
+    unit: str = pydantic.Field()
+    """
+    The unit of the value computed by the pricing metric.
+    """
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

lark/types/pricing_metric_summary_resource.py

@@ -0,0 +1,43 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .period import Period
+
+
+class PricingMetricSummaryResource(UniversalBaseModel):
+    id: str = pydantic.Field()
+    """
+    The ID of the pricing metric summary.
+    """
+
+    pricing_metric_id: str = pydantic.Field()
+    """
+    The ID of the pricing metric that the summary is for.
+    """
+
+    subject_id: str = pydantic.Field()
+    """
+    The ID of the subject that the summary is for.
+    """
+
+    period: Period = pydantic.Field()
+    """
+    The period that the summary is computed over.
+    """
+
+    value: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    The computed value of the pricing metric for the period. If the pricing metric does not have any usage events for the period, this will be `null`.
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

lark/types/rate_card_resource.py

@@ -1,5 +1,6 @@
 # This file was auto-generated by Fern from our API Definition.
 
+import datetime as dt
 import typing
 
 import pydantic
@@ -10,14 +11,42 @@ from .rate_card_resource_usage_based_rates_item import RateCardResourceUsageBase
 
 
 class RateCardResource(UniversalBaseModel):
-    id: str
-    name: str
-    description: str
-    usage_based_rates: typing.List[RateCardResourceUsageBasedRatesItem]
-    fixed_rates: typing.List[FixedRateInterface]
+    id: str = pydantic.Field()
+    """
+    The ID of the rate card.
+    """
+
+    name: str = pydantic.Field()
+    """
+    The name of the rate card.
+    """
+
+    description: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    The description of the rate card.
+    """
+
+    usage_based_rates: typing.List[RateCardResourceUsageBasedRatesItem] = pydantic.Field()
+    """
+    The usage based rates of the rate card.
+    """
+
+    fixed_rates: typing.List[FixedRateInterface] = pydantic.Field()
+    """
+    The fixed rates of the rate card.
+    """
+
     billing_interval: RateCardResourceBillingInterval
-    created_at: str
-    updated_at: str
+    created_at: dt.datetime = pydantic.Field()
+    """
+    The date and time the rate card was created.
+    """
+
+    updated_at: dt.datetime = pydantic.Field()
+    """
+    The date and time the rate card was last updated.
+    """
+
     metadata: typing.Dict[str, str]
 
     if IS_PYDANTIC_V2:

lark/types/rate_card_resource_usage_based_rates_item.py

@@ -13,7 +13,7 @@ class RateCardResourceUsageBasedRatesItem_Simple(UniversalBaseModel):
     usage_based_rate_type: typing.Literal["simple"] = "simple"
     id: str
     name: str
-    description: str
+    description: typing.Optional[str] = None
     price: Price
     included_units: int
     pricing_metric_id: str

lark/types/simple_usage_based_rate_interface.py

@@ -10,7 +10,7 @@ from .price import Price
 class SimpleUsageBasedRateInterface(UniversalBaseModel):
     id: str
     name: str
-    description: str
+    description: typing.Optional[str] = None
     price: Price
     included_units: int
     pricing_metric_id: str

lark/types/subscription_resource.py

@@ -10,15 +10,46 @@ from .subscription_status import SubscriptionStatus
 
 
 class SubscriptionResource(UniversalBaseModel):
-    id: str
-    subject_id: str
-    rate_card_id: str
-    effective_at: dt.datetime
-    cycles_next_at: typing.Optional[dt.datetime] = None
-    current_period: typing.Optional[PeriodResource] = None
+    id: str = pydantic.Field()
+    """
+    The ID of the subscription.
+    """
+
+    subject_id: str = pydantic.Field()
+    """
+    The ID of the subject that the subscription is for.
+    """
+
+    rate_card_id: str = pydantic.Field()
+    """
+    The ID of the rate card of the subscription.
+    """
+
+    effective_at: dt.datetime = pydantic.Field()
+    """
+    The date and time the subscription became effective.
+    """
+
+    cycles_next_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    The date and time the next cycle of the subscription will start.
+    """
+
+    current_period: typing.Optional[PeriodResource] = pydantic.Field(default=None)
+    """
+    The current period of the subscription if it is active.
+    """
+
     metadata: typing.Dict[str, str]
-    status: SubscriptionStatus
-    cancels_at_end_of_cycle: bool
+    status: SubscriptionStatus = pydantic.Field()
+    """
+    The status of the subscription.
+    """
+
+    cancels_at_end_of_cycle: bool = pydantic.Field()
+    """
+    Whether the subscription will be cancelled at the end of the current cycle.
+    """
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

lark/types/sum_aggregation_pricing_metric_interface.py

@@ -7,6 +7,10 @@ from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 
 
 class SumAggregationPricingMetricInterface(UniversalBaseModel):
+    """
+    Computes the sum of the `value_field` over all usage events with the specified `event_name`.
+    """
+
     value_field: str = pydantic.Field()
     """
     Field to sum over.

lark/types/sum_aggregation_pricing_metric_resource.py

@@ -7,7 +7,10 @@ from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 
 
 class SumAggregationPricingMetricResource(UniversalBaseModel):
-    value_field: str
+    value_field: str = pydantic.Field()
+    """
+    The field to sum over.
+    """
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

lark/usage_events/__init__.py

@@ -6,8 +6,8 @@ import typing
 from importlib import import_module
 
 if typing.TYPE_CHECKING:
-    from .types import CreateUsageEventSummaryRequestAggregationType
-_dynamic_imports: typing.Dict[str, str] = {"CreateUsageEventSummaryRequestAggregationType": ".types"}
+    from .types import CreateUsageEventRequestDataValue
+_dynamic_imports: typing.Dict[str, str] = {"CreateUsageEventRequestDataValue": ".types"}
 
 
 def __getattr__(attr_name: str) -> typing.Any:
@@ -31,4 +31,4 @@ def __dir__():
     return sorted(lazy_attrs)
 
 
-__all__ = ["CreateUsageEventSummaryRequestAggregationType"]
+__all__ = ["CreateUsageEventRequestDataValue"]

lark/usage_events/client.py

@@ -5,10 +5,8 @@ import typing
 
 from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
 from ..core.request_options import RequestOptions
-from ..types.create_usage_event_summary_response import CreateUsageEventSummaryResponse
-from ..types.period import Period
 from .raw_client import AsyncRawUsageEventsClient, RawUsageEventsClient
-from .types.create_usage_event_summary_request_aggregation_type import CreateUsageEventSummaryRequestAggregationType
+from .types.create_usage_event_request_data_value import CreateUsageEventRequestDataValue
 
 # this is used as the default value for optional parameters
 OMIT = typing.cast(typing.Any, ...)
@@ -35,7 +33,7 @@ class UsageEventsClient:
         idempotency_key: str,
         event_name: str,
         subject_id: str,
-        data: typing.Dict[str, typing.Optional[typing.Any]],
+        data: typing.Dict[str, CreateUsageEventRequestDataValue],
         timestamp: typing.Optional[dt.datetime] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> typing.Optional[typing.Any]:
@@ -43,14 +41,19 @@ class UsageEventsClient:
         Parameters
         ----------
         idempotency_key : str
+            The idempotency key for the usage event. This ensures that the same event is not processed multiple times.
 
         event_name : str
+            The name of the event. This is used by pricing metrics to aggregate usage events.
 
         subject_id : str
+            The ID of the subject that the usage event is for.
 
-        data : typing.Dict[str, typing.Optional[typing.Any]]
+        data : typing.Dict[str, CreateUsageEventRequestDataValue]
+            The data of the usage event. This should contain any data that is needed to aggregate the usage event.
 
         timestamp : typing.Optional[dt.datetime]
+            The timestamp of the usage event. It is highly recommended to provide a timestamp. If not provided, the current timestamp will be used.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -62,16 +65,25 @@ class UsageEventsClient:
 
         Examples
         --------
+        import datetime
+
         from lark import Lark
 
         client = Lark(
             api_key="YOUR_API_KEY",
         )
         client.usage_events.create_usage_event(
-            idempotency_key="idempotency_key",
-            event_name="event_name",
-            subject_id="subject_id",
-            data={"key": "value"},
+            idempotency_key="6b4ef298-4566-427d-b2ca-cd8fbe38ec60",
+            event_name="compute_hours",
+            subject_id="subj_VyX6Q96h5avMho8O7QWlKeXE",
+            timestamp=datetime.datetime.fromisoformat(
+                "2025-10-31 20:29:47+00:00",
+            ),
+            data={
+                "compute_hours": 100,
+                "instance_type": "t2.micro",
+                "region": "us-east-1",
+            },
         )
         """
         _response = self._raw_client.create_usage_event(
@@ -84,60 +96,6 @@ class UsageEventsClient:
         )
         return _response.data
 
-    def create_usage_event_summary(
-        self,
-        *,
-        event_name: str,
-        subject_id: str,
-        period: Period,
-        aggregation_type: CreateUsageEventSummaryRequestAggregationType,
-        request_options: typing.Optional[RequestOptions] = None,
-    ) -> CreateUsageEventSummaryResponse:
-        """
-        Parameters
-        ----------
-        event_name : str
-
-        subject_id : str
-
-        period : Period
-
-        aggregation_type : CreateUsageEventSummaryRequestAggregationType
-
-        request_options : typing.Optional[RequestOptions]
-            Request-specific configuration.
-
-        Returns
-        -------
-        CreateUsageEventSummaryResponse
-            Successful Response
-
-        Examples
-        --------
-        from lark import Lark, Period
-
-        client = Lark(
-            api_key="YOUR_API_KEY",
-        )
-        client.usage_events.create_usage_event_summary(
-            event_name="event_name",
-            subject_id="subject_id",
-            period=Period(
-                start="2024-01-15T09:30:00Z",
-                end="2024-01-15T09:30:00Z",
-            ),
-            aggregation_type="sum",
-        )
-        """
-        _response = self._raw_client.create_usage_event_summary(
-            event_name=event_name,
-            subject_id=subject_id,
-            period=period,
-            aggregation_type=aggregation_type,
-            request_options=request_options,
-        )
-        return _response.data
-
 
 class AsyncUsageEventsClient:
     def __init__(self, *, client_wrapper: AsyncClientWrapper):
@@ -160,7 +118,7 @@ class AsyncUsageEventsClient:
         idempotency_key: str,
         event_name: str,
         subject_id: str,
-        data: typing.Dict[str, typing.Optional[typing.Any]],
+        data: typing.Dict[str, CreateUsageEventRequestDataValue],
         timestamp: typing.Optional[dt.datetime] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> typing.Optional[typing.Any]:
@@ -168,14 +126,19 @@ class AsyncUsageEventsClient:
         Parameters
         ----------
         idempotency_key : str
+            The idempotency key for the usage event. This ensures that the same event is not processed multiple times.
 
         event_name : str
+            The name of the event. This is used by pricing metrics to aggregate usage events.
 
         subject_id : str
+            The ID of the subject that the usage event is for.
 
-        data : typing.Dict[str, typing.Optional[typing.Any]]
+        data : typing.Dict[str, CreateUsageEventRequestDataValue]
+            The data of the usage event. This should contain any data that is needed to aggregate the usage event.
 
         timestamp : typing.Optional[dt.datetime]
+            The timestamp of the usage event. It is highly recommended to provide a timestamp. If not provided, the current timestamp will be used.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -188,6 +151,7 @@ class AsyncUsageEventsClient:
         Examples
         --------
         import asyncio
+        import datetime
 
         from lark import AsyncLark
 
@@ -198,10 +162,17 @@ class AsyncUsageEventsClient:
 
         async def main() -> None:
             await client.usage_events.create_usage_event(
-                idempotency_key="idempotency_key",
-                event_name="event_name",
-                subject_id="subject_id",
-                data={"key": "value"},
+                idempotency_key="6b4ef298-4566-427d-b2ca-cd8fbe38ec60",
+                event_name="compute_hours",
+                subject_id="subj_VyX6Q96h5avMho8O7QWlKeXE",
+                timestamp=datetime.datetime.fromisoformat(
+                    "2025-10-31 20:29:47+00:00",
+                ),
+                data={
+                    "compute_hours": 100,
+                    "instance_type": "t2.micro",
+                    "region": "us-east-1",
+                },
             )
 
 
@@ -216,65 +187,3 @@ class AsyncUsageEventsClient:
             request_options=request_options,
         )
         return _response.data
-
-    async def create_usage_event_summary(
-        self,
-        *,
-        event_name: str,
-        subject_id: str,
-        period: Period,
-        aggregation_type: CreateUsageEventSummaryRequestAggregationType,
-        request_options: typing.Optional[RequestOptions] = None,
-    ) -> CreateUsageEventSummaryResponse:
-        """
-        Parameters
-        ----------
-        event_name : str
-
-        subject_id : str
-
-        period : Period
-
-        aggregation_type : CreateUsageEventSummaryRequestAggregationType
-
-        request_options : typing.Optional[RequestOptions]
-            Request-specific configuration.
-
-        Returns
-        -------
-        CreateUsageEventSummaryResponse
-            Successful Response
-
-        Examples
-        --------
-        import asyncio
-
-        from lark import AsyncLark, Period
-
-        client = AsyncLark(
-            api_key="YOUR_API_KEY",
-        )
-
-
-        async def main() -> None:
-            await client.usage_events.create_usage_event_summary(
-                event_name="event_name",
-                subject_id="subject_id",
-                period=Period(
-                    start="2024-01-15T09:30:00Z",
-                    end="2024-01-15T09:30:00Z",
-                ),
-                aggregation_type="sum",
-            )
-
-
-        asyncio.run(main())
-        """
-        _response = await self._raw_client.create_usage_event_summary(
-            event_name=event_name,
-            subject_id=subject_id,
-            period=period,
-            aggregation_type=aggregation_type,
-            request_options=request_options,
-        )
-        return _response.data