lark-billing 0.5.0__py3-none-any.whl

lark/types/pricing_metric_create_params.py

@@ -0,0 +1,98 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Union, Optional
+from typing_extensions import Literal, Required, TypeAlias, TypedDict
+
+from .._types import SequenceNotStr
+
+__all__ = [
+    "PricingMetricCreateParams",
+    "Aggregation",
+    "AggregationSumAggregationPricingMetricInterface",
+    "AggregationCountAggregationPricingMetricInterface",
+    "AggregationMaxAggregationPricingMetricInterface",
+    "AggregationLastAggregationPricingMetricInterface",
+    "AggregationCustomAggregationPricingMetricInterface",
+]
+
+
+class PricingMetricCreateParams(TypedDict, total=False):
+    aggregation: Required[Aggregation]
+    """The aggregation function used to compute the value of the pricing metric."""
+
+    event_name: Required[str]
+    """The name of the event that the pricing metric is computed on."""
+
+    name: Required[str]
+    """The name of the pricing metric."""
+
+    unit: Required[str]
+    """Unit of measurement for the pricing metric."""
+
+    dimensions: Optional[SequenceNotStr[str]]
+    """The dimensions by which the events are grouped to compute the pricing metric."""
+
+
+class AggregationSumAggregationPricingMetricInterface(TypedDict, total=False):
+    """
+    Computes the sum of the `value_field` over all usage events with the specified `event_name`.
+    """
+
+    aggregation_type: Required[Literal["sum"]]
+
+    value_field: Required[str]
+    """Field to sum over."""
+
+
+class AggregationCountAggregationPricingMetricInterface(TypedDict, total=False):
+    """Computes the number of usage events with the specified `event_name`."""
+
+    aggregation_type: Required[Literal["count"]]
+
+
+class AggregationMaxAggregationPricingMetricInterface(TypedDict, total=False):
+    """
+    Computes the max value of the `value_field` over all usage events with the specified `event_name`.
+    """
+
+    aggregation_type: Required[Literal["max"]]
+
+    value_field: Required[str]
+    """Field to get the max value of."""
+
+
+class AggregationLastAggregationPricingMetricInterface(TypedDict, total=False):
+    """
+    Computes the last value of the `value_field` over all usage events with the specified `event_name`.
+    """
+
+    aggregation_type: Required[Literal["last"]]
+
+    value_field: Required[str]
+    """Field to get the last value of."""
+
+
+class AggregationCustomAggregationPricingMetricInterface(TypedDict, total=False):
+    """Custom aggregation for use cases not supported by the other aggregation types.
+
+    Please email team@uselark.ai to enable this feature.
+    """
+
+    aggregation_type: Required[Literal["custom"]]
+
+    custom_expression: Required[str]
+    """Custom expression to compute the pricing metric.
+
+    Please email team@uselark.ai to enable this feature.
+    """
+
+
+Aggregation: TypeAlias = Union[
+    AggregationSumAggregationPricingMetricInterface,
+    AggregationCountAggregationPricingMetricInterface,
+    AggregationMaxAggregationPricingMetricInterface,
+    AggregationLastAggregationPricingMetricInterface,
+    AggregationCustomAggregationPricingMetricInterface,
+]

lark/types/pricing_metric_create_summary_params.py

@@ -0,0 +1,25 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Optional
+from typing_extensions import Literal, Required, TypedDict
+
+from .._types import SequenceNotStr
+from .period_param import PeriodParam
+
+__all__ = ["PricingMetricCreateSummaryParams"]
+
+
+class PricingMetricCreateSummaryParams(TypedDict, total=False):
+    period: Required[PeriodParam]
+    """The period that the summary should be computed over."""
+
+    subject_id: Required[str]
+    """The ID or external ID of the subject that the summary should be computed for."""
+
+    dimensions: Optional[SequenceNotStr[str]]
+    """The dimensions by which the events are grouped to compute the pricing metric."""
+
+    period_granularity: Optional[Literal["hour", "day", "week"]]
+    """The granularity of the period that the summary should be computed over."""

lark/types/pricing_metric_create_summary_response.py

@@ -0,0 +1,36 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, List, Optional
+from typing_extensions import TypeAlias
+
+from .period import Period
+from .._models import BaseModel
+
+__all__ = ["PricingMetricCreateSummaryResponse", "PricingMetricCreateSummaryResponseItem"]
+
+
+class PricingMetricCreateSummaryResponseItem(BaseModel):
+    id: str
+    """The ID of the pricing metric summary."""
+
+    dimension_coordinates: Optional[Dict[str, str]] = None
+    """The dimension coordinates that the summary is for."""
+
+    period: Period
+    """The period that the summary is computed over."""
+
+    pricing_metric_id: str
+    """The ID of the pricing metric that the summary is for."""
+
+    subject_id: str
+    """The ID of the subject that the summary is for."""
+
+    value: Optional[str] = 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`.
+    """
+
+
+PricingMetricCreateSummaryResponse: TypeAlias = List[PricingMetricCreateSummaryResponseItem]

lark/types/pricing_metric_list_params.py

@@ -0,0 +1,11 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import TypedDict
+
+__all__ = ["PricingMetricListParams"]
+
+
+class PricingMetricListParams(TypedDict, total=False):
+    limit: int

lark/types/pricing_metric_list_response.py

@@ -0,0 +1,14 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List
+
+from .._models import BaseModel
+from .pricing_metric_resource import PricingMetricResource
+
+__all__ = ["PricingMetricListResponse"]
+
+
+class PricingMetricListResponse(BaseModel):
+    has_more: bool
+
+    pricing_metrics: List[PricingMetricResource]

lark/types/pricing_metric_resource.py

@@ -0,0 +1,72 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Union, Optional
+from typing_extensions import Literal, Annotated, TypeAlias
+
+from .._utils import PropertyInfo
+from .._models import BaseModel
+
+__all__ = [
+    "PricingMetricResource",
+    "Aggregation",
+    "AggregationSumAggregationPricingMetricResource",
+    "AggregationCountAggregationPricingMetricResource",
+    "AggregationMaxAggregationPricingMetricResource",
+    "AggregationLastAggregationPricingMetricResource",
+]
+
+
+class AggregationSumAggregationPricingMetricResource(BaseModel):
+    aggregation_type: Literal["sum"]
+
+    value_field: str
+    """The field to sum over."""
+
+
+class AggregationCountAggregationPricingMetricResource(BaseModel):
+    aggregation_type: Literal["count"]
+
+
+class AggregationMaxAggregationPricingMetricResource(BaseModel):
+    aggregation_type: Literal["max"]
+
+    value_field: str
+    """The field to get the max value of."""
+
+
+class AggregationLastAggregationPricingMetricResource(BaseModel):
+    aggregation_type: Literal["last"]
+
+    value_field: str
+    """The field to get the last value of."""
+
+
+Aggregation: TypeAlias = Annotated[
+    Union[
+        AggregationSumAggregationPricingMetricResource,
+        AggregationCountAggregationPricingMetricResource,
+        AggregationMaxAggregationPricingMetricResource,
+        AggregationLastAggregationPricingMetricResource,
+    ],
+    PropertyInfo(discriminator="aggregation_type"),
+]
+
+
+class PricingMetricResource(BaseModel):
+    id: str
+    """The ID of the pricing metric."""
+
+    aggregation: Aggregation
+    """The aggregation function used to compute the value of the pricing metric."""
+
+    event_name: str
+    """The event name that the pricing metric is computed on."""
+
+    name: str
+    """The name of the pricing metric."""
+
+    unit: str
+    """The unit of the value computed by the pricing metric."""
+
+    dimensions: Optional[List[str]] = None
+    """The dimensions by which the events are grouped to compute the pricing metric."""

lark/types/rate_card_create_params.py

@@ -0,0 +1,148 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Dict, Union, Iterable, Optional
+from typing_extensions import Literal, Required, TypeAlias, TypedDict
+
+from .._types import SequenceNotStr
+from .flat_price_input_param import FlatPriceInputParam
+from .package_price_input_param import PackagePriceInputParam
+
+__all__ = [
+    "RateCardCreateParams",
+    "FixedRate",
+    "FixedRatePrice",
+    "UsageBasedRate",
+    "UsageBasedRateCreateSimpleUsageBasedRateRequest",
+    "UsageBasedRateCreateSimpleUsageBasedRateRequestPrice",
+    "UsageBasedRateCreateDimensionalUsageBasedRateRequest",
+    "UsageBasedRateCreateDimensionalUsageBasedRateRequestDimension",
+    "UsageBasedRateCreateDimensionalUsageBasedRateRequestPricingMatrix",
+    "UsageBasedRateCreateDimensionalUsageBasedRateRequestPricingMatrixCell",
+    "UsageBasedRateCreateDimensionalUsageBasedRateRequestPricingMatrixCellPrice",
+]
+
+
+class RateCardCreateParams(TypedDict, total=False):
+    billing_interval: Required[Literal["monthly", "yearly"]]
+    """How often the customer will be billed for this rate card."""
+
+    name: Required[str]
+    """The name of the rate card displayed to the customer."""
+
+    description: Optional[str]
+    """The description of the rate card displayed to the customer."""
+
+    fixed_rates: Iterable[FixedRate]
+    """The fixed rates of the rate card.
+
+    These are billed at the start of each billing cycle.
+    """
+
+    metadata: Dict[str, str]
+
+    usage_based_rates: Iterable[UsageBasedRate]
+    """The usage based rates of the rate card.
+
+    These are billed at the end of each billing cycle.
+    """
+
+
+FixedRatePrice: TypeAlias = Union[FlatPriceInputParam, PackagePriceInputParam]
+
+
+class FixedRate(TypedDict, total=False):
+    name: Required[str]
+    """The name of the rate displayed to the customer."""
+
+    price: Required[FixedRatePrice]
+    """Flat price is a price that linearly scales with the quantity."""
+
+    description: Optional[str]
+    """The description of the rate displayed to the customer."""
+
+
+UsageBasedRateCreateSimpleUsageBasedRateRequestPrice: TypeAlias = Union[FlatPriceInputParam, PackagePriceInputParam]
+
+
+class UsageBasedRateCreateSimpleUsageBasedRateRequest(TypedDict, total=False):
+    name: Required[str]
+    """The name of the rate displayed to the customer."""
+
+    price: Required[UsageBasedRateCreateSimpleUsageBasedRateRequestPrice]
+    """Flat price is a price that linearly scales with the quantity."""
+
+    pricing_metric_id: Required[str]
+    """The ID of the pricing metric to use for this rate."""
+
+    usage_based_rate_type: Required[Literal["simple"]]
+
+    description: Optional[str]
+    """The description of the rate displayed to the customer."""
+
+    included_units: int
+    """The number of units included in the rate before the price is applied."""
+
+
+class UsageBasedRateCreateDimensionalUsageBasedRateRequestDimension(TypedDict, total=False):
+    key: Required[str]
+    """The name of the dimension.
+
+    This is used to identify the dimension in the pricing matrix.
+    """
+
+    values: Required[SequenceNotStr[str]]
+    """A list of possible values for the dimension."""
+
+    description: Optional[str]
+    """The description of the dimension."""
+
+
+UsageBasedRateCreateDimensionalUsageBasedRateRequestPricingMatrixCellPrice: TypeAlias = Union[
+    FlatPriceInputParam, PackagePriceInputParam
+]
+
+
+class UsageBasedRateCreateDimensionalUsageBasedRateRequestPricingMatrixCell(TypedDict, total=False):
+    dimension_coordinates: Required[Dict[str, str]]
+    """
+    A key-value mapping of dimension keys and values to identify the price for a
+    given set of dimension values.
+    """
+
+    price: Required[UsageBasedRateCreateDimensionalUsageBasedRateRequestPricingMatrixCellPrice]
+    """The price for the cell."""
+
+
+class UsageBasedRateCreateDimensionalUsageBasedRateRequestPricingMatrix(TypedDict, total=False):
+    """The pricing matrix of the rate."""
+
+    cells: Required[Iterable[UsageBasedRateCreateDimensionalUsageBasedRateRequestPricingMatrixCell]]
+
+
+class UsageBasedRateCreateDimensionalUsageBasedRateRequest(TypedDict, total=False):
+    dimensions: Required[Iterable[UsageBasedRateCreateDimensionalUsageBasedRateRequestDimension]]
+    """The dimensions of the rate."""
+
+    name: Required[str]
+    """The name of the rate displayed to the customer."""
+
+    pricing_matrix: Required[UsageBasedRateCreateDimensionalUsageBasedRateRequestPricingMatrix]
+    """The pricing matrix of the rate."""
+
+    pricing_metric_id: Required[str]
+    """The ID of the pricing metric to use for this rate."""
+
+    usage_based_rate_type: Required[Literal["dimensional"]]
+
+    description: Optional[str]
+    """The description of the rate displayed to the customer."""
+
+    included_units: int
+    """The number of units included in the rate before the price is applied."""
+
+
+UsageBasedRate: TypeAlias = Union[
+    UsageBasedRateCreateSimpleUsageBasedRateRequest, UsageBasedRateCreateDimensionalUsageBasedRateRequest
+]

lark/types/rate_card_list_params.py

@@ -0,0 +1,13 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import TypedDict
+
+__all__ = ["RateCardListParams"]
+
+
+class RateCardListParams(TypedDict, total=False):
+    limit: int
+
+    offset: int

lark/types/rate_card_list_response.py

@@ -0,0 +1,14 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List
+
+from .._models import BaseModel
+from .rate_card_resource import RateCardResource
+
+__all__ = ["RateCardListResponse"]
+
+
+class RateCardListResponse(BaseModel):
+    has_more: bool
+
+    rate_cards: List[RateCardResource]

lark/types/rate_card_resource.py

@@ -0,0 +1,141 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, List, Union, Optional
+from datetime import datetime
+from typing_extensions import Literal, Annotated, TypeAlias
+
+from .._utils import PropertyInfo
+from .._models import BaseModel
+from .flat_price_output import FlatPriceOutput
+from .package_price_output import PackagePriceOutput
+
+__all__ = [
+    "RateCardResource",
+    "FixedRate",
+    "FixedRatePrice",
+    "UsageBasedRate",
+    "UsageBasedRateSimpleUsageBasedRateInterface",
+    "UsageBasedRateSimpleUsageBasedRateInterfacePrice",
+    "UsageBasedRateDimensionalUsageBasedRateInterface",
+    "UsageBasedRateDimensionalUsageBasedRateInterfaceDimension",
+    "UsageBasedRateDimensionalUsageBasedRateInterfacePricingMatrix",
+    "UsageBasedRateDimensionalUsageBasedRateInterfacePricingMatrixCell",
+    "UsageBasedRateDimensionalUsageBasedRateInterfacePricingMatrixCellPrice",
+]
+
+FixedRatePrice: TypeAlias = Annotated[
+    Union[FlatPriceOutput, PackagePriceOutput], PropertyInfo(discriminator="price_type")
+]
+
+
+class FixedRate(BaseModel):
+    id: str
+
+    description: Optional[str] = None
+
+    name: str
+
+    price: FixedRatePrice
+    """Flat price is a price that linearly scales with the quantity."""
+
+
+UsageBasedRateSimpleUsageBasedRateInterfacePrice: TypeAlias = Annotated[
+    Union[FlatPriceOutput, PackagePriceOutput], PropertyInfo(discriminator="price_type")
+]
+
+
+class UsageBasedRateSimpleUsageBasedRateInterface(BaseModel):
+    id: str
+
+    description: Optional[str] = None
+
+    included_units: int
+
+    name: str
+
+    price: UsageBasedRateSimpleUsageBasedRateInterfacePrice
+    """Flat price is a price that linearly scales with the quantity."""
+
+    pricing_metric_id: str
+
+    usage_based_rate_type: Optional[Literal["simple"]] = None
+
+
+class UsageBasedRateDimensionalUsageBasedRateInterfaceDimension(BaseModel):
+    description: Optional[str] = None
+
+    key: str
+
+    values: List[str]
+
+
+UsageBasedRateDimensionalUsageBasedRateInterfacePricingMatrixCellPrice: TypeAlias = Annotated[
+    Union[FlatPriceOutput, PackagePriceOutput], PropertyInfo(discriminator="price_type")
+]
+
+
+class UsageBasedRateDimensionalUsageBasedRateInterfacePricingMatrixCell(BaseModel):
+    dimension_coordinates: Dict[str, str]
+
+    price: UsageBasedRateDimensionalUsageBasedRateInterfacePricingMatrixCellPrice
+    """Flat price is a price that linearly scales with the quantity."""
+
+
+class UsageBasedRateDimensionalUsageBasedRateInterfacePricingMatrix(BaseModel):
+    cells: List[UsageBasedRateDimensionalUsageBasedRateInterfacePricingMatrixCell]
+
+
+class UsageBasedRateDimensionalUsageBasedRateInterface(BaseModel):
+    id: str
+
+    description: Optional[str] = None
+
+    dimensions: List[UsageBasedRateDimensionalUsageBasedRateInterfaceDimension]
+
+    included_units: int
+
+    name: str
+
+    pricing_matrix: UsageBasedRateDimensionalUsageBasedRateInterfacePricingMatrix
+
+    pricing_metric_id: str
+
+    usage_based_rate_type: Optional[Literal["dimensional"]] = None
+
+
+UsageBasedRate: TypeAlias = Annotated[
+    Union[UsageBasedRateSimpleUsageBasedRateInterface, UsageBasedRateDimensionalUsageBasedRateInterface],
+    PropertyInfo(discriminator="usage_based_rate_type"),
+]
+
+
+class RateCardResource(BaseModel):
+    id: str
+    """The ID of the rate card."""
+
+    billing_interval: Literal["monthly", "yearly"]
+    """How often the customer will be billed for this rate card."""
+
+    created_at: datetime
+    """The date and time the rate card was created."""
+
+    fixed_rates: List[FixedRate]
+    """The fixed rates of the rate card."""
+
+    metadata: Dict[str, str]
+    """Additional metadata about the rate card.
+
+    You may use this to store any custom data about the rate card.
+    """
+
+    name: str
+    """The name of the rate card."""
+
+    updated_at: datetime
+    """The date and time the rate card was last updated."""
+
+    usage_based_rates: List[UsageBasedRate]
+    """The usage based rates of the rate card."""
+
+    description: Optional[str] = None
+    """The description of the rate card."""

lark/types/subject_create_params.py

@@ -0,0 +1,29 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Dict, Optional
+from typing_extensions import TypedDict
+
+__all__ = ["SubjectCreateParams"]
+
+
+class SubjectCreateParams(TypedDict, total=False):
+    email: Optional[str]
+    """The email of the subject. Must be a valid email address."""
+
+    external_id: Optional[str]
+    """The ID of the subject in your system.
+
+    If provided, you may use pass it to the API in place of the subject ID. Must be
+    unique.
+    """
+
+    metadata: Dict[str, str]
+    """Additional metadata about the subject.
+
+    You may use this to store any custom data about the subject.
+    """
+
+    name: Optional[str]
+    """The name of the subject. Used for display in the dashboard."""

lark/types/subject_create_response.py

@@ -0,0 +1,34 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, Optional
+from datetime import datetime
+
+from .._models import BaseModel
+
+__all__ = ["SubjectCreateResponse"]
+
+
+class SubjectCreateResponse(BaseModel):
+    id: str
+    """The ID of the subject."""
+
+    created_at: datetime
+    """The date and time the subject was created."""
+
+    email: Optional[str] = None
+    """The email of the subject."""
+
+    external_id: Optional[str] = None
+    """The ID of the subject in your system.
+
+    You may pass it to the API in place of the subject ID.
+    """
+
+    metadata: Dict[str, str]
+    """Additional metadata about the subject.
+
+    You may use this to store any custom data about the subject.
+    """
+
+    name: Optional[str] = None
+    """The name of the subject. Used for display in the dashboard."""

lark/types/subject_list_params.py

@@ -0,0 +1,13 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import TypedDict
+
+__all__ = ["SubjectListParams"]
+
+
+class SubjectListParams(TypedDict, total=False):
+    limit: int
+
+    offset: int

lark/types/subject_list_response.py

@@ -0,0 +1,14 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List
+
+from .._models import BaseModel
+from .subject_resource import SubjectResource
+
+__all__ = ["SubjectListResponse"]
+
+
+class SubjectListResponse(BaseModel):
+    has_more: bool
+
+    subjects: List[SubjectResource]