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

lark/pricing_metrics/raw_client.py

@@ -11,10 +11,11 @@ from ..core.pydantic_utilities import parse_obj_as
 from ..core.request_options import RequestOptions
 from ..core.serialization import convert_and_respect_annotation_metadata
 from ..errors.unprocessable_entity_error import UnprocessableEntityError
-from ..types.create_pricing_metric_response import CreatePricingMetricResponse
-from ..types.get_pricing_metric_response import GetPricingMetricResponse
 from ..types.http_validation_error import HttpValidationError
 from ..types.list_pricing_metrics_response import ListPricingMetricsResponse
+from ..types.period import Period
+from ..types.pricing_metric_resource import PricingMetricResource
+from ..types.pricing_metric_summary_resource import PricingMetricSummaryResource
 from .types.pricing_metric_aggregation import PricingMetricAggregation
 
 # this is used as the default value for optional parameters
@@ -83,25 +84,28 @@ class RawPricingMetricsClient:
         aggregation: PricingMetricAggregation,
         unit: str,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> HttpResponse[CreatePricingMetricResponse]:
+    ) -> HttpResponse[PricingMetricResource]:
         """
         Parameters
         ----------
         name : str
+            The name of the pricing metric.
 
         event_name : str
+            The name of the event that the pricing metric is computed on.
 
         aggregation : PricingMetricAggregation
+            The aggregation function used to compute the value of the pricing metric.
 
         unit : str
-            Unit of measurement for the pricing metric
+            Unit of measurement for the pricing metric.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
         Returns
         -------
-        HttpResponse[CreatePricingMetricResponse]
+        HttpResponse[PricingMetricResource]
             Successful Response
         """
         _response = self._client_wrapper.httpx_client.request(
@@ -124,9 +128,9 @@ class RawPricingMetricsClient:
         try:
             if 200 <= _response.status_code < 300:
                 _data = typing.cast(
-                    CreatePricingMetricResponse,
+                    PricingMetricResource,
                     parse_obj_as(
-                        type_=CreatePricingMetricResponse,  # type: ignore
+                        type_=PricingMetricResource,  # type: ignore
                         object_=_response.json(),
                     ),
                 )
@@ -149,7 +153,7 @@ class RawPricingMetricsClient:
 
     def get_pricing_metric(
         self, pricing_metric_id: str, *, request_options: typing.Optional[RequestOptions] = None
-    ) -> HttpResponse[GetPricingMetricResponse]:
+    ) -> HttpResponse[PricingMetricResource]:
         """
         Parameters
         ----------
@@ -160,7 +164,7 @@ class RawPricingMetricsClient:
 
         Returns
         -------
-        HttpResponse[GetPricingMetricResponse]
+        HttpResponse[PricingMetricResource]
             Successful Response
         """
         _response = self._client_wrapper.httpx_client.request(
@@ -171,9 +175,75 @@ class RawPricingMetricsClient:
         try:
             if 200 <= _response.status_code < 300:
                 _data = typing.cast(
-                    GetPricingMetricResponse,
+                    PricingMetricResource,
                     parse_obj_as(
-                        type_=GetPricingMetricResponse,  # type: ignore
+                        type_=PricingMetricResource,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return HttpResponse(response=_response, data=_data)
+            if _response.status_code == 422:
+                raise UnprocessableEntityError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        HttpValidationError,
+                        parse_obj_as(
+                            type_=HttpValidationError,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+    def create_pricing_metric_summary(
+        self,
+        pricing_metric_id: str,
+        *,
+        subject_id: str,
+        period: Period,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> HttpResponse[PricingMetricSummaryResource]:
+        """
+        Parameters
+        ----------
+        pricing_metric_id : str
+
+        subject_id : str
+            The ID of the subject that the summary should be computed for.
+
+        period : Period
+            The period that the summary should be computed over.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        HttpResponse[PricingMetricSummaryResource]
+            Successful Response
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"pricing-metrics/{jsonable_encoder(pricing_metric_id)}/summary",
+            method="POST",
+            json={
+                "subject_id": subject_id,
+                "period": convert_and_respect_annotation_metadata(object_=period, annotation=Period, direction="write"),
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    PricingMetricSummaryResource,
+                    parse_obj_as(
+                        type_=PricingMetricSummaryResource,  # type: ignore
                         object_=_response.json(),
                     ),
                 )
@@ -257,25 +327,28 @@ class AsyncRawPricingMetricsClient:
         aggregation: PricingMetricAggregation,
         unit: str,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> AsyncHttpResponse[CreatePricingMetricResponse]:
+    ) -> AsyncHttpResponse[PricingMetricResource]:
         """
         Parameters
         ----------
         name : str
+            The name of the pricing metric.
 
         event_name : str
+            The name of the event that the pricing metric is computed on.
 
         aggregation : PricingMetricAggregation
+            The aggregation function used to compute the value of the pricing metric.
 
         unit : str
-            Unit of measurement for the pricing metric
+            Unit of measurement for the pricing metric.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
         Returns
         -------
-        AsyncHttpResponse[CreatePricingMetricResponse]
+        AsyncHttpResponse[PricingMetricResource]
             Successful Response
         """
         _response = await self._client_wrapper.httpx_client.request(
@@ -298,9 +371,9 @@ class AsyncRawPricingMetricsClient:
         try:
             if 200 <= _response.status_code < 300:
                 _data = typing.cast(
-                    CreatePricingMetricResponse,
+                    PricingMetricResource,
                     parse_obj_as(
-                        type_=CreatePricingMetricResponse,  # type: ignore
+                        type_=PricingMetricResource,  # type: ignore
                         object_=_response.json(),
                     ),
                 )
@@ -323,7 +396,7 @@ class AsyncRawPricingMetricsClient:
 
     async def get_pricing_metric(
         self, pricing_metric_id: str, *, request_options: typing.Optional[RequestOptions] = None
-    ) -> AsyncHttpResponse[GetPricingMetricResponse]:
+    ) -> AsyncHttpResponse[PricingMetricResource]:
         """
         Parameters
         ----------
@@ -334,7 +407,7 @@ class AsyncRawPricingMetricsClient:
 
         Returns
         -------
-        AsyncHttpResponse[GetPricingMetricResponse]
+        AsyncHttpResponse[PricingMetricResource]
             Successful Response
         """
         _response = await self._client_wrapper.httpx_client.request(
@@ -345,9 +418,75 @@ class AsyncRawPricingMetricsClient:
         try:
             if 200 <= _response.status_code < 300:
                 _data = typing.cast(
-                    GetPricingMetricResponse,
+                    PricingMetricResource,
+                    parse_obj_as(
+                        type_=PricingMetricResource,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return AsyncHttpResponse(response=_response, data=_data)
+            if _response.status_code == 422:
+                raise UnprocessableEntityError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        HttpValidationError,
+                        parse_obj_as(
+                            type_=HttpValidationError,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+    async def create_pricing_metric_summary(
+        self,
+        pricing_metric_id: str,
+        *,
+        subject_id: str,
+        period: Period,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> AsyncHttpResponse[PricingMetricSummaryResource]:
+        """
+        Parameters
+        ----------
+        pricing_metric_id : str
+
+        subject_id : str
+            The ID of the subject that the summary should be computed for.
+
+        period : Period
+            The period that the summary should be computed over.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncHttpResponse[PricingMetricSummaryResource]
+            Successful Response
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"pricing-metrics/{jsonable_encoder(pricing_metric_id)}/summary",
+            method="POST",
+            json={
+                "subject_id": subject_id,
+                "period": convert_and_respect_annotation_metadata(object_=period, annotation=Period, direction="write"),
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    PricingMetricSummaryResource,
                     parse_obj_as(
-                        type_=GetPricingMetricResponse,  # type: ignore
+                        type_=PricingMetricSummaryResource,  # type: ignore
                         object_=_response.json(),
                     ),
                 )

lark/pricing_metrics/types/__init__.py

@@ -9,11 +9,17 @@ if typing.TYPE_CHECKING:
     from .pricing_metric_aggregation import (
         PricingMetricAggregation,
         PricingMetricAggregation_Count,
+        PricingMetricAggregation_Custom,
+        PricingMetricAggregation_Last,
+        PricingMetricAggregation_Max,
         PricingMetricAggregation_Sum,
     )
 _dynamic_imports: typing.Dict[str, str] = {
     "PricingMetricAggregation": ".pricing_metric_aggregation",
     "PricingMetricAggregation_Count": ".pricing_metric_aggregation",
+    "PricingMetricAggregation_Custom": ".pricing_metric_aggregation",
+    "PricingMetricAggregation_Last": ".pricing_metric_aggregation",
+    "PricingMetricAggregation_Max": ".pricing_metric_aggregation",
     "PricingMetricAggregation_Sum": ".pricing_metric_aggregation",
 }
 
@@ -39,4 +45,11 @@ def __dir__():
     return sorted(lazy_attrs)
 
 
-__all__ = ["PricingMetricAggregation", "PricingMetricAggregation_Count", "PricingMetricAggregation_Sum"]
+__all__ = [
+    "PricingMetricAggregation",
+    "PricingMetricAggregation_Count",
+    "PricingMetricAggregation_Custom",
+    "PricingMetricAggregation_Last",
+    "PricingMetricAggregation_Max",
+    "PricingMetricAggregation_Sum",
+]

lark/pricing_metrics/types/pricing_metric_aggregation.py

@@ -9,6 +9,10 @@ from ...core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 
 
 class PricingMetricAggregation_Count(UniversalBaseModel):
+    """
+    The aggregation function used to compute the value of the pricing metric.
+    """
+
     aggregation_type: typing.Literal["count"] = "count"
 
     if IS_PYDANTIC_V2:
@@ -21,7 +25,65 @@ class PricingMetricAggregation_Count(UniversalBaseModel):
             extra = pydantic.Extra.allow
 
 
+class PricingMetricAggregation_Custom(UniversalBaseModel):
+    """
+    The aggregation function used to compute the value of the pricing metric.
+    """
+
+    aggregation_type: typing.Literal["custom"] = "custom"
+    custom_expression: str
+
+    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
+
+
+class PricingMetricAggregation_Last(UniversalBaseModel):
+    """
+    The aggregation function used to compute the value of the pricing metric.
+    """
+
+    aggregation_type: typing.Literal["last"] = "last"
+    value_field: str
+
+    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
+
+
+class PricingMetricAggregation_Max(UniversalBaseModel):
+    """
+    The aggregation function used to compute the value of the pricing metric.
+    """
+
+    aggregation_type: typing.Literal["max"] = "max"
+    value_field: str
+
+    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
+
+
 class PricingMetricAggregation_Sum(UniversalBaseModel):
+    """
+    The aggregation function used to compute the value of the pricing metric.
+    """
+
     aggregation_type: typing.Literal["sum"] = "sum"
     value_field: str
 
@@ -35,4 +97,10 @@ class PricingMetricAggregation_Sum(UniversalBaseModel):
             extra = pydantic.Extra.allow
 
 
-PricingMetricAggregation = typing.Union[PricingMetricAggregation_Count, PricingMetricAggregation_Sum]
+PricingMetricAggregation = typing.Union[
+    PricingMetricAggregation_Count,
+    PricingMetricAggregation_Custom,
+    PricingMetricAggregation_Last,
+    PricingMetricAggregation_Max,
+    PricingMetricAggregation_Sum,
+]

lark/rate_cards/client.py

@@ -84,8 +84,10 @@ class RateCardsClient:
             The description of the rate card displayed to the customer.
 
         fixed_rates : typing.Optional[typing.Sequence[CreateFixedRateRequest]]
+            The fixed rates of the rate card. These are billed at the start of each billing cycle.
 
         usage_based_rates : typing.Optional[typing.Sequence[CreateRateCardRequestUsageBasedRatesItem]]
+            The usage based rates of the rate card. These are billed at the end of each billing cycle.
 
         metadata : typing.Optional[typing.Dict[str, str]]
 
@@ -99,14 +101,40 @@ class RateCardsClient:
 
         Examples
         --------
-        from lark import Lark
+        from lark import Amount, CreateFixedRateRequest, Lark, Price_Flat
+        from lark.rate_cards import CreateRateCardRequestUsageBasedRatesItem_Simple
 
         client = Lark(
             api_key="YOUR_API_KEY",
         )
         client.rate_cards.create_rate_card(
             name="Pro Plan",
+            description="For production applications with moderate usage.",
             billing_interval="monthly",
+            fixed_rates=[
+                CreateFixedRateRequest(
+                    name="Base Rate",
+                    price=Price_Flat(
+                        amount=Amount(
+                            value="2500",
+                            currency_code="usd",
+                        ),
+                    ),
+                )
+            ],
+            usage_based_rates=[
+                CreateRateCardRequestUsageBasedRatesItem_Simple(
+                    name="name",
+                    price=Price_Flat(
+                        amount=Amount(
+                            value="2500",
+                            currency_code="usd",
+                        ),
+                    ),
+                    pricing_metric_id="pricing_metric_id",
+                )
+            ],
+            metadata={"key": "value"},
         )
         """
         _response = self._raw_client.create_rate_card(
@@ -228,8 +256,10 @@ class AsyncRateCardsClient:
             The description of the rate card displayed to the customer.
 
         fixed_rates : typing.Optional[typing.Sequence[CreateFixedRateRequest]]
+            The fixed rates of the rate card. These are billed at the start of each billing cycle.
 
         usage_based_rates : typing.Optional[typing.Sequence[CreateRateCardRequestUsageBasedRatesItem]]
+            The usage based rates of the rate card. These are billed at the end of each billing cycle.
 
         metadata : typing.Optional[typing.Dict[str, str]]
 
@@ -245,7 +275,8 @@ class AsyncRateCardsClient:
         --------
         import asyncio
 
-        from lark import AsyncLark
+        from lark import Amount, AsyncLark, CreateFixedRateRequest, Price_Flat
+        from lark.rate_cards import CreateRateCardRequestUsageBasedRatesItem_Simple
 
         client = AsyncLark(
             api_key="YOUR_API_KEY",
@@ -255,7 +286,32 @@ class AsyncRateCardsClient:
         async def main() -> None:
             await client.rate_cards.create_rate_card(
                 name="Pro Plan",
+                description="For production applications with moderate usage.",
                 billing_interval="monthly",
+                fixed_rates=[
+                    CreateFixedRateRequest(
+                        name="Base Rate",
+                        price=Price_Flat(
+                            amount=Amount(
+                                value="2500",
+                                currency_code="usd",
+                            ),
+                        ),
+                    )
+                ],
+                usage_based_rates=[
+                    CreateRateCardRequestUsageBasedRatesItem_Simple(
+                        name="name",
+                        price=Price_Flat(
+                            amount=Amount(
+                                value="2500",
+                                currency_code="usd",
+                            ),
+                        ),
+                        pricing_metric_id="pricing_metric_id",
+                    )
+                ],
+                metadata={"key": "value"},
             )
 
 

lark/rate_cards/raw_client.py

@@ -100,8 +100,10 @@ class RawRateCardsClient:
             The description of the rate card displayed to the customer.
 
         fixed_rates : typing.Optional[typing.Sequence[CreateFixedRateRequest]]
+            The fixed rates of the rate card. These are billed at the start of each billing cycle.
 
         usage_based_rates : typing.Optional[typing.Sequence[CreateRateCardRequestUsageBasedRatesItem]]
+            The usage based rates of the rate card. These are billed at the end of each billing cycle.
 
         metadata : typing.Optional[typing.Dict[str, str]]
 
@@ -288,8 +290,10 @@ class AsyncRawRateCardsClient:
             The description of the rate card displayed to the customer.
 
         fixed_rates : typing.Optional[typing.Sequence[CreateFixedRateRequest]]
+            The fixed rates of the rate card. These are billed at the start of each billing cycle.
 
         usage_based_rates : typing.Optional[typing.Sequence[CreateRateCardRequestUsageBasedRatesItem]]
+            The usage based rates of the rate card. These are billed at the end of each billing cycle.
 
         metadata : typing.Optional[typing.Dict[str, str]]
 

lark/subjects/client.py

@@ -104,7 +104,12 @@ class SubjectsClient:
         client = Lark(
             api_key="YOUR_API_KEY",
         )
-        client.subjects.create_subject()
+        client.subjects.create_subject(
+            external_id="user_1234567890",
+            name="John Doe",
+            email="john.doe@example.com",
+            metadata={"key": "value"},
+        )
         """
         _response = self._raw_client.create_subject(
             external_id=external_id, name=name, email=email, metadata=metadata, request_options=request_options
@@ -323,7 +328,12 @@ class AsyncSubjectsClient:
 
 
         async def main() -> None:
-            await client.subjects.create_subject()
+            await client.subjects.create_subject(
+                external_id="user_1234567890",
+                name="John Doe",
+                email="john.doe@example.com",
+                metadata={"key": "value"},
+            )
 
 
         asyncio.run(main())