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

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

@@ -7,15 +7,12 @@ from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 from .aggregation import Aggregation
 
 
-class PricingMetricInterface(UniversalBaseModel):
+class CreatePricingMetricResponse(UniversalBaseModel):
     id: str
     name: str
     event_name: str
     aggregation: Aggregation
-    unit: str = pydantic.Field()
-    """
-    Unit of the value computed by the pricing metric.
-    """
+    unit: str
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

lark/types/{create_simple_usage_based_rate_interface.py → create_simple_usage_based_rate_request.py}

@@ -4,21 +4,18 @@ import typing
 
 import pydantic
 from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
-from .create_pricing_metric_interface import CreatePricingMetricInterface
 from .price import Price
 
 
-class CreateSimpleUsageBasedRateInterface(UniversalBaseModel):
-    code: str = pydantic.Field()
-    """
-    Code of this rate to be used for overrides and external reference.
-    """
-
-    name: str
+class CreateSimpleUsageBasedRateRequest(UniversalBaseModel):
+    name: typing.Optional[str] = None
     description: typing.Optional[str] = None
     price: Price
     included_units: typing.Optional[int] = None
-    pricing_metric: CreatePricingMetricInterface
+    pricing_metric_id: str = pydantic.Field()
+    """
+    The ID of the pricing metric to use for this rate.
+    """
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

lark/types/create_subject_response.py

@@ -1,5 +1,6 @@
 # This file was auto-generated by Fern from our API Definition.
 
+import datetime as dt
 import typing
 
 import pydantic
@@ -7,12 +8,35 @@ from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 
 
 class CreateSubjectResponse(UniversalBaseModel):
-    id: str
-    external_id: typing.Optional[str] = None
-    name: typing.Optional[str] = None
-    email: typing.Optional[str] = None
-    parent_subject_id: typing.Optional[str] = None
-    metadata: typing.Dict[str, str]
+    id: str = pydantic.Field()
+    """
+    The ID of the subject.
+    """
+
+    external_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    The ID of the subject in your system. You may pass it to the API in place of the subject ID.
+    """
+
+    name: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    The name of the subject. Used for display in the dashboard.
+    """
+
+    email: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    The email of the subject.
+    """
+
+    metadata: typing.Dict[str, str] = pydantic.Field()
+    """
+    Additional metadata about the subject. You may use this to store any custom data about the subject.
+    """
+
+    created_at: dt.datetime = pydantic.Field()
+    """
+    The date and time the subject was created.
+    """
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

lark/types/create_subscription_checkout_session_response.py

@@ -10,8 +10,7 @@ from .amount import Amount
 class CreateSubscriptionCheckoutSessionResponse(UniversalBaseModel):
     id: str
     amount: Amount
-    payment_intent_client_secret: typing.Optional[str] = None
-    setup_intent_client_secret: typing.Optional[str] = None
+    url: str
 
     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

@@ -10,7 +10,7 @@ from .period import Period
 class CreateUsageEventSummaryResponse(UniversalBaseModel):
     event_name: str
     subject_id: str
-    value: typing.Optional[float] = None
+    value: typing.Optional[str] = None
     period: Period
 
     if IS_PYDANTIC_V2:

lark/types/fixed_rate_interface.py

@@ -4,7 +4,6 @@ import typing
 
 import pydantic
 from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
-from .credit_grant_interface import CreditGrantInterface
 from .price import Price
 
 
@@ -13,11 +12,6 @@ class FixedRateInterface(UniversalBaseModel):
     name: str
     description: str
     price: Price
-    credit_grants: typing.List[CreditGrantInterface]
-    quantity_code: typing.Optional[str] = pydantic.Field(default=None)
-    """
-    Code of this rate to be used for setting quantity.
-    """
 
     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_interface.py → get_pricing_metric_response.py}

@@ -7,14 +7,12 @@ from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 from .aggregation import Aggregation
 
 
-class CreatePricingMetricInterface(UniversalBaseModel):
+class GetPricingMetricResponse(UniversalBaseModel):
+    id: str
     name: str
     event_name: str
     aggregation: Aggregation
-    unit: str = pydantic.Field()
-    """
-    Unit of the value computed by the pricing metric.
-    """
+    unit: str
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

lark/types/{complete_subscription_checkout_response.py → invoice_line_item_resource.py}

@@ -7,9 +7,11 @@ from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 from .amount import Amount
 
 
-class CompleteSubscriptionCheckoutResponse(UniversalBaseModel):
-    id: str
+class InvoiceLineItemResource(UniversalBaseModel):
     amount: Amount
+    description: str
+    quantity: int
+    price_in_unit_amount: Amount
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

lark/types/invoice_resource.py

@@ -0,0 +1,31 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .amount import Amount
+from .invoice_line_item_resource import InvoiceLineItemResource
+from .invoice_status import InvoiceStatus
+
+
+class InvoiceResource(UniversalBaseModel):
+    id: str
+    merchant_id: str
+    bill_id: typing.Optional[str] = None
+    total_amount: Amount
+    subject_id: str
+    created_at: dt.datetime
+    status: InvoiceStatus
+    hosted_url: typing.Optional[str] = None
+    line_items: typing.List[InvoiceLineItemResource]
+
+    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/invoice_status.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+InvoiceStatus = typing.Union[typing.Literal["draft", "open", "paid", "uncollectible", "void"], typing.Any]

lark/types/{check_feature_access_response.py → list_invoices_response.py}

@@ -4,12 +4,12 @@ import typing
 
 import pydantic
 from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .invoice_resource import InvoiceResource
 
 
-class CheckFeatureAccessResponse(UniversalBaseModel):
-    feature_code: str
-    subject_id: str
-    feature_access: bool
+class ListInvoicesResponse(UniversalBaseModel):
+    invoices: typing.List[InvoiceResource]
+    has_more: bool
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

lark/types/{check_feature_access_request.py → list_pricing_metrics_response.py}

@@ -4,15 +4,12 @@ import typing
 
 import pydantic
 from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .pricing_metric_resource import PricingMetricResource
 
 
-class CheckFeatureAccessRequest(UniversalBaseModel):
-    feature_code: str = pydantic.Field()
-    """
-    References `feature_code` from a usage-based rate.
-    """
-
-    subject_id: str
+class ListPricingMetricsResponse(UniversalBaseModel):
+    pricing_metrics: typing.List[PricingMetricResource]
+    has_more: bool
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

lark/types/package_price.py

@@ -5,7 +5,7 @@ import typing
 import pydantic
 from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 from .amount import Amount
-from .package_price_rounding_behavior import PackagePriceRoundingBehavior
+from .package_price_output_rounding_behavior import PackagePriceOutputRoundingBehavior
 
 
 class PackagePrice(UniversalBaseModel):
@@ -15,7 +15,7 @@ class PackagePrice(UniversalBaseModel):
 
     amount: Amount
     package_units: int
-    rounding_behavior: PackagePriceRoundingBehavior
+    rounding_behavior: PackagePriceOutputRoundingBehavior
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

lark/types/package_price_input_rounding_behavior.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+PackagePriceInputRoundingBehavior = typing.Union[typing.Literal["round_up", "round_down"], typing.Any]

lark/types/package_price_output_rounding_behavior.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+PackagePriceOutputRoundingBehavior = typing.Union[typing.Literal["round_up", "round_down"], typing.Any]

lark/types/period_resource.py

@@ -0,0 +1,23 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+
+
+class PeriodResource(UniversalBaseModel):
+    inclusive_start: typing.Optional[bool] = None
+    inclusive_end: typing.Optional[bool] = None
+    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
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

lark/types/price.py

@@ -1,5 +1,43 @@
 # This file was auto-generated by Fern from our API Definition.
 
+from __future__ import annotations
+
 import typing
 
-Price = typing.Optional[typing.Any]
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .amount import Amount
+from .package_price_output_rounding_behavior import PackagePriceOutputRoundingBehavior
+
+
+class Price_Flat(UniversalBaseModel):
+    price_type: typing.Literal["flat"] = "flat"
+    amount: Amount
+
+    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 Price_Package(UniversalBaseModel):
+    price_type: typing.Literal["package"] = "package"
+    amount: Amount
+    package_units: int
+    rounding_behavior: PackagePriceOutputRoundingBehavior
+
+    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
+
+
+Price = typing.Union[Price_Flat, Price_Package]

lark/types/pricing_metric_resource.py

@@ -0,0 +1,24 @@
+# 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 .aggregation import Aggregation
+
+
+class PricingMetricResource(UniversalBaseModel):
+    id: str
+    name: str
+    event_name: str
+    aggregation: Aggregation
+    unit: 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

lark/types/rate_card_resource.py

@@ -4,8 +4,6 @@ import typing
 
 import pydantic
 from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
-from .credit_grant_resource import CreditGrantResource
-from .feature_access_resource import FeatureAccessResource
 from .fixed_rate_interface import FixedRateInterface
 from .rate_card_resource_billing_interval import RateCardResourceBillingInterval
 from .rate_card_resource_usage_based_rates_item import RateCardResourceUsageBasedRatesItem
@@ -18,12 +16,8 @@ class RateCardResource(UniversalBaseModel):
     usage_based_rates: typing.List[RateCardResourceUsageBasedRatesItem]
     fixed_rates: typing.List[FixedRateInterface]
     billing_interval: RateCardResourceBillingInterval
-    credit_grants: typing.List[CreditGrantResource]
     created_at: str
     updated_at: str
-    major_version: int
-    minor_version: int
-    feature_access: typing.List[FeatureAccessResource]
     metadata: typing.Dict[str, str]
 
     if IS_PYDANTIC_V2:

lark/types/rate_card_resource_usage_based_rates_item.py

@@ -6,42 +6,17 @@ import typing
 
 import pydantic
 from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
-from .dimension_interface import DimensionInterface
 from .price import Price
-from .pricing_matrix_interface import PricingMatrixInterface
-from .pricing_metric_interface import PricingMetricInterface
-
-
-class RateCardResourceUsageBasedRatesItem_Dimensional(UniversalBaseModel):
-    usage_based_rate_type: typing.Literal["dimensional"] = "dimensional"
-    id: str
-    code: str
-    name: str
-    description: str
-    included_units: int
-    pricing_metric: PricingMetricInterface
-    dimensions: typing.List[DimensionInterface]
-    pricing_matrix: PricingMatrixInterface
-
-    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 RateCardResourceUsageBasedRatesItem_Simple(UniversalBaseModel):
     usage_based_rate_type: typing.Literal["simple"] = "simple"
     id: str
-    code: str
     name: str
     description: str
     price: Price
     included_units: int
-    pricing_metric: PricingMetricInterface
+    pricing_metric_id: str
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
@@ -53,6 +28,4 @@ class RateCardResourceUsageBasedRatesItem_Simple(UniversalBaseModel):
             extra = pydantic.Extra.allow
 
 
-RateCardResourceUsageBasedRatesItem = typing.Union[
-    RateCardResourceUsageBasedRatesItem_Dimensional, RateCardResourceUsageBasedRatesItem_Simple
-]
+RateCardResourceUsageBasedRatesItem = RateCardResourceUsageBasedRatesItem_Simple

lark/types/simple_usage_based_rate_interface.py

@@ -5,21 +5,15 @@ import typing
 import pydantic
 from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 from .price import Price
-from .pricing_metric_interface import PricingMetricInterface
 
 
 class SimpleUsageBasedRateInterface(UniversalBaseModel):
     id: str
-    code: str = pydantic.Field()
-    """
-    Code of this rate to be used for overrides and external reference.
-    """
-
     name: str
     description: str
     price: Price
     included_units: int
-    pricing_metric: PricingMetricInterface
+    pricing_metric_id: str
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

lark/types/subject_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
@@ -7,12 +8,35 @@ from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 
 
 class SubjectResource(UniversalBaseModel):
-    id: str
-    external_id: typing.Optional[str] = None
-    name: typing.Optional[str] = None
-    email: typing.Optional[str] = None
-    parent_subject_id: typing.Optional[str] = None
-    metadata: typing.Dict[str, str]
+    id: str = pydantic.Field()
+    """
+    The ID of the subject.
+    """
+
+    external_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    The ID of the subject in your system. You may pass it to the API in place of the subject ID.
+    """
+
+    name: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    The name of the subject. Used for display in the dashboard.
+    """
+
+    email: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    The email of the subject.
+    """
+
+    metadata: typing.Dict[str, str] = pydantic.Field()
+    """
+    Additional metadata about the subject. You may use this to store any custom data about the subject.
+    """
+
+    created_at: dt.datetime = pydantic.Field()
+    """
+    The date and time the subject was created.
+    """
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

lark/types/subscription_resource.py

@@ -5,7 +5,8 @@ import typing
 
 import pydantic
 from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
-from .status import Status
+from .period_resource import PeriodResource
+from .subscription_status import SubscriptionStatus
 
 
 class SubscriptionResource(UniversalBaseModel):
@@ -14,9 +15,10 @@ class SubscriptionResource(UniversalBaseModel):
     rate_card_id: str
     effective_at: dt.datetime
     cycles_next_at: typing.Optional[dt.datetime] = None
-    variables: typing.Optional[typing.Dict[str, typing.Optional[str]]] = None
-    metadata: typing.Optional[typing.Dict[str, typing.Optional[str]]] = None
-    status: Status
+    current_period: typing.Optional[PeriodResource] = None
+    metadata: typing.Dict[str, str]
+    status: SubscriptionStatus
+    cancels_at_end_of_cycle: bool
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

lark/types/subscription_status.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+SubscriptionStatus = typing.Union[typing.Literal["active", "cancelled", "paused"], typing.Any]

lark/types/{credit_grant_date_time_expiration_resource.py → sum_aggregation_pricing_metric_resource.py}

@@ -6,8 +6,8 @@ import pydantic
 from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 
 
-class CreditGrantDateTimeExpirationResource(UniversalBaseModel):
-    date: str
+class SumAggregationPricingMetricResource(UniversalBaseModel):
+    value_field: str
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

lark/types/{subject.py → value.py}

@@ -2,4 +2,4 @@
 
 import typing
 
-Subject = typing.Optional[typing.Any]
+Value = typing.Union[float, str]