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

lark/types/__init__.py

@@ -6,30 +6,32 @@ import typing
 from importlib import import_module
 
 if typing.TYPE_CHECKING:
-    from .aggregation import Aggregation, Aggregation_Count, Aggregation_Sum
+    from .aggregation import Aggregation, Aggregation_Count, Aggregation_Last, Aggregation_Max, Aggregation_Sum
     from .amount import Amount
     from .billing_state_response import BillingStateResponse
     from .count_aggregation_pricing_metric_interface import CountAggregationPricingMetricInterface
     from .count_aggregation_pricing_metric_resource import CountAggregationPricingMetricResource
     from .create_customer_portal_session_response import CreateCustomerPortalSessionResponse
     from .create_fixed_rate_request import CreateFixedRateRequest
-    from .create_pricing_metric_response import CreatePricingMetricResponse
     from .create_simple_usage_based_rate_request import CreateSimpleUsageBasedRateRequest
     from .create_subject_response import CreateSubjectResponse
     from .create_subscription_checkout_session_response import CreateSubscriptionCheckoutSessionResponse
-    from .create_usage_event_summary_response import CreateUsageEventSummaryResponse
+    from .custom_aggregation_pricing_metric_interface import CustomAggregationPricingMetricInterface
     from .fixed_rate_interface import FixedRateInterface
     from .flat_price import FlatPrice
-    from .get_pricing_metric_response import GetPricingMetricResponse
     from .http_validation_error import HttpValidationError
     from .invoice_line_item_resource import InvoiceLineItemResource
     from .invoice_resource import InvoiceResource
     from .invoice_status import InvoiceStatus
+    from .last_aggregation_pricing_metric_interface import LastAggregationPricingMetricInterface
+    from .last_aggregation_pricing_metric_resource import LastAggregationPricingMetricResource
     from .list_invoices_response import ListInvoicesResponse
     from .list_pricing_metrics_response import ListPricingMetricsResponse
     from .list_rate_cards_response import ListRateCardsResponse
     from .list_subjects_response import ListSubjectsResponse
     from .list_subscriptions_response import ListSubscriptionsResponse
+    from .max_aggregation_pricing_metric_interface import MaxAggregationPricingMetricInterface
+    from .max_aggregation_pricing_metric_resource import MaxAggregationPricingMetricResource
     from .package_price import PackagePrice
     from .package_price_input_rounding_behavior import PackagePriceInputRoundingBehavior
     from .package_price_output_rounding_behavior import PackagePriceOutputRoundingBehavior
@@ -37,6 +39,7 @@ if typing.TYPE_CHECKING:
     from .period_resource import PeriodResource
     from .price import Price, Price_Flat, Price_Package
     from .pricing_metric_resource import PricingMetricResource
+    from .pricing_metric_summary_resource import PricingMetricSummaryResource
     from .rate_card_resource import RateCardResource
     from .rate_card_resource_billing_interval import RateCardResourceBillingInterval
     from .rate_card_resource_usage_based_rates_item import (
@@ -51,10 +54,11 @@ if typing.TYPE_CHECKING:
     from .sum_aggregation_pricing_metric_resource import SumAggregationPricingMetricResource
     from .validation_error import ValidationError
     from .validation_error_loc_item import ValidationErrorLocItem
-    from .value import Value
 _dynamic_imports: typing.Dict[str, str] = {
     "Aggregation": ".aggregation",
     "Aggregation_Count": ".aggregation",
+    "Aggregation_Last": ".aggregation",
+    "Aggregation_Max": ".aggregation",
     "Aggregation_Sum": ".aggregation",
     "Amount": ".amount",
     "BillingStateResponse": ".billing_state_response",
@@ -62,23 +66,25 @@ _dynamic_imports: typing.Dict[str, str] = {
     "CountAggregationPricingMetricResource": ".count_aggregation_pricing_metric_resource",
     "CreateCustomerPortalSessionResponse": ".create_customer_portal_session_response",
     "CreateFixedRateRequest": ".create_fixed_rate_request",
-    "CreatePricingMetricResponse": ".create_pricing_metric_response",
     "CreateSimpleUsageBasedRateRequest": ".create_simple_usage_based_rate_request",
     "CreateSubjectResponse": ".create_subject_response",
     "CreateSubscriptionCheckoutSessionResponse": ".create_subscription_checkout_session_response",
-    "CreateUsageEventSummaryResponse": ".create_usage_event_summary_response",
+    "CustomAggregationPricingMetricInterface": ".custom_aggregation_pricing_metric_interface",
     "FixedRateInterface": ".fixed_rate_interface",
     "FlatPrice": ".flat_price",
-    "GetPricingMetricResponse": ".get_pricing_metric_response",
     "HttpValidationError": ".http_validation_error",
     "InvoiceLineItemResource": ".invoice_line_item_resource",
     "InvoiceResource": ".invoice_resource",
     "InvoiceStatus": ".invoice_status",
+    "LastAggregationPricingMetricInterface": ".last_aggregation_pricing_metric_interface",
+    "LastAggregationPricingMetricResource": ".last_aggregation_pricing_metric_resource",
     "ListInvoicesResponse": ".list_invoices_response",
     "ListPricingMetricsResponse": ".list_pricing_metrics_response",
     "ListRateCardsResponse": ".list_rate_cards_response",
     "ListSubjectsResponse": ".list_subjects_response",
     "ListSubscriptionsResponse": ".list_subscriptions_response",
+    "MaxAggregationPricingMetricInterface": ".max_aggregation_pricing_metric_interface",
+    "MaxAggregationPricingMetricResource": ".max_aggregation_pricing_metric_resource",
     "PackagePrice": ".package_price",
     "PackagePriceInputRoundingBehavior": ".package_price_input_rounding_behavior",
     "PackagePriceOutputRoundingBehavior": ".package_price_output_rounding_behavior",
@@ -88,6 +94,7 @@ _dynamic_imports: typing.Dict[str, str] = {
     "Price_Flat": ".price",
     "Price_Package": ".price",
     "PricingMetricResource": ".pricing_metric_resource",
+    "PricingMetricSummaryResource": ".pricing_metric_summary_resource",
     "RateCardResource": ".rate_card_resource",
     "RateCardResourceBillingInterval": ".rate_card_resource_billing_interval",
     "RateCardResourceUsageBasedRatesItem": ".rate_card_resource_usage_based_rates_item",
@@ -100,7 +107,6 @@ _dynamic_imports: typing.Dict[str, str] = {
     "SumAggregationPricingMetricResource": ".sum_aggregation_pricing_metric_resource",
     "ValidationError": ".validation_error",
     "ValidationErrorLocItem": ".validation_error_loc_item",
-    "Value": ".value",
 }
 
 
@@ -128,6 +134,8 @@ def __dir__():
 __all__ = [
     "Aggregation",
     "Aggregation_Count",
+    "Aggregation_Last",
+    "Aggregation_Max",
     "Aggregation_Sum",
     "Amount",
     "BillingStateResponse",
@@ -135,23 +143,25 @@ __all__ = [
     "CountAggregationPricingMetricResource",
     "CreateCustomerPortalSessionResponse",
     "CreateFixedRateRequest",
-    "CreatePricingMetricResponse",
     "CreateSimpleUsageBasedRateRequest",
     "CreateSubjectResponse",
     "CreateSubscriptionCheckoutSessionResponse",
-    "CreateUsageEventSummaryResponse",
+    "CustomAggregationPricingMetricInterface",
     "FixedRateInterface",
     "FlatPrice",
-    "GetPricingMetricResponse",
     "HttpValidationError",
     "InvoiceLineItemResource",
     "InvoiceResource",
     "InvoiceStatus",
+    "LastAggregationPricingMetricInterface",
+    "LastAggregationPricingMetricResource",
     "ListInvoicesResponse",
     "ListPricingMetricsResponse",
     "ListRateCardsResponse",
     "ListSubjectsResponse",
     "ListSubscriptionsResponse",
+    "MaxAggregationPricingMetricInterface",
+    "MaxAggregationPricingMetricResource",
     "PackagePrice",
     "PackagePriceInputRoundingBehavior",
     "PackagePriceOutputRoundingBehavior",
@@ -161,6 +171,7 @@ __all__ = [
     "Price_Flat",
     "Price_Package",
     "PricingMetricResource",
+    "PricingMetricSummaryResource",
     "RateCardResource",
     "RateCardResourceBillingInterval",
     "RateCardResourceUsageBasedRatesItem",
@@ -173,5 +184,4 @@ __all__ = [
     "SumAggregationPricingMetricResource",
     "ValidationError",
     "ValidationErrorLocItem",
-    "Value",
 ]

lark/types/aggregation.py

@@ -9,6 +9,10 @@ from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 
 
 class Aggregation_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,47 @@ class Aggregation_Count(UniversalBaseModel):
             extra = pydantic.Extra.allow
 
 
+class Aggregation_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 Aggregation_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 Aggregation_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 +79,4 @@ class Aggregation_Sum(UniversalBaseModel):
             extra = pydantic.Extra.allow
 
 
-Aggregation = typing.Union[Aggregation_Count, Aggregation_Sum]
+Aggregation = typing.Union[Aggregation_Count, Aggregation_Last, Aggregation_Max, Aggregation_Sum]

lark/types/billing_state_response.py

@@ -7,8 +7,15 @@ from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 
 
 class BillingStateResponse(UniversalBaseModel):
-    has_active_subscription: bool
-    has_overage_for_usage: bool
+    has_active_subscription: bool = pydantic.Field()
+    """
+    Whether the subject has an active subscription.
+    """
+
+    has_overage_for_usage: bool = pydantic.Field()
+    """
+    Whether the subject has exceeded the included usage (if any) on a usage-based rate they are subscribed to.
+    """
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

lark/types/count_aggregation_pricing_metric_interface.py

@@ -7,6 +7,10 @@ from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 
 
 class CountAggregationPricingMetricInterface(UniversalBaseModel):
+    """
+    Computes the number of usage events with the specified `event_name`.
+    """
+
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
     else:

lark/types/custom_aggregation_pricing_metric_interface.py

@@ -0,0 +1,26 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+
+
+class CustomAggregationPricingMetricInterface(UniversalBaseModel):
+    """
+    Custom aggregation for use cases not supported by the other aggregation types. Please email team@uselark.ai to enable this feature.
+    """
+
+    custom_expression: str = pydantic.Field()
+    """
+    Custom expression to compute the pricing metric. Please email team@uselark.ai to enable this feature.
+    """
+
+    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/last_aggregation_pricing_metric_interface.py

@@ -0,0 +1,26 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+
+
+class LastAggregationPricingMetricInterface(UniversalBaseModel):
+    """
+    Computes the last value of the `value_field` over all usage events with the specified `event_name`.
+    """
+
+    value_field: str = pydantic.Field()
+    """
+    Field to get the last value of.
+    """
+
+    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/{get_pricing_metric_response.py → last_aggregation_pricing_metric_resource.py}

@@ -4,15 +4,13 @@ import typing
 
 import pydantic
 from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
-from .aggregation import Aggregation
 
 
-class GetPricingMetricResponse(UniversalBaseModel):
-    id: str
-    name: str
-    event_name: str
-    aggregation: Aggregation
-    unit: str
+class LastAggregationPricingMetricResource(UniversalBaseModel):
+    value_field: str = pydantic.Field()
+    """
+    The field to get the last value of.
+    """
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

lark/types/{create_usage_event_summary_response.py → max_aggregation_pricing_metric_interface.py}

@@ -4,14 +4,17 @@ import typing
 
 import pydantic
 from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
-from .period import Period
 
 
-class CreateUsageEventSummaryResponse(UniversalBaseModel):
-    event_name: str
-    subject_id: str
-    value: typing.Optional[str] = None
-    period: Period
+class MaxAggregationPricingMetricInterface(UniversalBaseModel):
+    """
+    Computes the max value of the `value_field` over all usage events with the specified `event_name`.
+    """
+
+    value_field: str = pydantic.Field()
+    """
+    Field to get the max value of.
+    """
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

lark/types/{create_pricing_metric_response.py → max_aggregation_pricing_metric_resource.py}

@@ -4,15 +4,13 @@ import typing
 
 import pydantic
 from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
-from .aggregation import Aggregation
 
 
-class CreatePricingMetricResponse(UniversalBaseModel):
-    id: str
-    name: str
-    event_name: str
-    aggregation: Aggregation
-    unit: str
+class MaxAggregationPricingMetricResource(UniversalBaseModel):
+    value_field: str = pydantic.Field()
+    """
+    The field to get the max value of.
+    """
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

lark/types/period.py

@@ -1,5 +1,6 @@
 # This file was auto-generated by Fern from our API Definition.
 
+import datetime as dt
 import typing
 
 import pydantic
@@ -9,8 +10,8 @@ from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 class Period(UniversalBaseModel):
     inclusive_start: typing.Optional[bool] = None
     inclusive_end: typing.Optional[bool] = None
-    start: str
-    end: str
+    start: dt.datetime
+    end: dt.datetime
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

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