lark-billing 0.5.0__py3-none-any.whl

lark/types/subject_resource.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__ = ["SubjectResource"]
+
+
+class SubjectResource(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_update_params.py

@@ -0,0 +1,22 @@
+# 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 Required, TypedDict
+
+__all__ = ["SubjectUpdateParams"]
+
+
+class SubjectUpdateParams(TypedDict, total=False):
+    email: Required[Optional[str]]
+    """The email of the subject. Must be a valid email address."""
+
+    metadata: Required[Optional[Dict[str, str]]]
+    """Additional metadata about the subject.
+
+    You may use this to store any custom data about the subject.
+    """
+
+    name: Required[Optional[str]]
+    """The name of the subject. Used for display in the dashboard."""

lark/types/subscription_cancel_params.py

@@ -0,0 +1,16 @@
+# 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, TypedDict
+
+__all__ = ["SubscriptionCancelParams"]
+
+
+class SubscriptionCancelParams(TypedDict, total=False):
+    cancel_at_end_of_cycle: Literal[True]
+    """Whether to cancel the subscription at end of cycle."""
+
+    reason: Optional[str]
+    """The reason for cancelling the subscription."""

lark/types/subscription_change_rate_card_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 Optional
+from typing_extensions import Literal, Required, TypedDict
+
+from .checkout_callback_param import CheckoutCallbackParam
+
+__all__ = ["SubscriptionChangeRateCardParams"]
+
+
+class SubscriptionChangeRateCardParams(TypedDict, total=False):
+    rate_card_id: Required[str]
+    """The ID of the rate card to change the subscription to."""
+
+    checkout_callback_urls: Optional[CheckoutCallbackParam]
+    """
+    The URLs to redirect to after the checkout is completed or cancelled, if a
+    checkout is required.
+    """
+
+    upgrade_behavior: Literal["prorate", "rate_difference"]
+    """The behavior to use when upgrading the subscription.
+
+    If 'prorate', the customer will be charged for the prorated difference. If
+    'rate_difference', the customer will be charged for the difference in the rate
+    cards without respect to time.
+    """

lark/types/subscription_change_rate_card_response.py

@@ -0,0 +1,55 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Union
+from typing_extensions import Literal, Annotated, TypeAlias
+
+from .._utils import PropertyInfo
+from .._models import BaseModel
+from .subscription_resource import SubscriptionResource
+
+__all__ = [
+    "SubscriptionChangeRateCardResponse",
+    "Result",
+    "ResultChangeSubscriptionRateCardRequiresActionResponse",
+    "ResultChangeSubscriptionRateCardRequiresActionResponseAction",
+    "ResultChangeSubscriptionRateCardSuccessResponse",
+]
+
+
+class ResultChangeSubscriptionRateCardRequiresActionResponseAction(BaseModel):
+    """The action to take to complete the request."""
+
+    checkout_url: str
+    """The URL of the checkout page to redirect to in order to complete the request."""
+
+    type: Literal["checkout"]
+
+
+class ResultChangeSubscriptionRateCardRequiresActionResponse(BaseModel):
+    action: ResultChangeSubscriptionRateCardRequiresActionResponseAction
+    """The action to take to complete the request."""
+
+    type: Literal["requires_action"]
+
+
+class ResultChangeSubscriptionRateCardSuccessResponse(BaseModel):
+    subscription: SubscriptionResource
+    """The updated subscription resource."""
+
+    type: Literal["success"]
+
+
+Result: TypeAlias = Annotated[
+    Union[ResultChangeSubscriptionRateCardRequiresActionResponse, ResultChangeSubscriptionRateCardSuccessResponse],
+    PropertyInfo(discriminator="type"),
+]
+
+
+class SubscriptionChangeRateCardResponse(BaseModel):
+    result: Result
+    """The result of the request.
+
+    If the request is successful, the subscription resource will be returned. If the
+    request is requires action, the action to take to complete the request will be
+    returned.
+    """

lark/types/subscription_create_params.py

@@ -0,0 +1,38 @@
+# 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 Literal, Required, TypedDict
+
+from .checkout_callback_param import CheckoutCallbackParam
+
+__all__ = ["SubscriptionCreateParams"]
+
+
+class SubscriptionCreateParams(TypedDict, total=False):
+    rate_card_id: Required[str]
+    """The ID of the rate card to use for the subscription."""
+
+    subject_id: Required[str]
+    """The ID or external ID of the subject to create the subscription for."""
+
+    checkout_callback_urls: Optional[CheckoutCallbackParam]
+    """
+    The URLs to redirect to after the checkout is completed or cancelled, if a
+    checkout is required.
+    """
+
+    create_checkout_session: Literal["when_required", "always"]
+    """
+    Determines whether a checkout session is always required even if the subject has
+    a payment method on file. By default, if the subject has a payment method on
+    file or the subscription is for a free plan, the subscription will be created
+    and billed for immediately (if for a paid plan).
+    """
+
+    metadata: Dict[str, str]
+    """Additional metadata about the subscription.
+
+    You may use this to store any custom data about the subscription.
+    """

lark/types/subscription_create_response.py

@@ -0,0 +1,55 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Union
+from typing_extensions import Literal, Annotated, TypeAlias
+
+from .._utils import PropertyInfo
+from .._models import BaseModel
+from .subscription_resource import SubscriptionResource
+
+__all__ = [
+    "SubscriptionCreateResponse",
+    "Result",
+    "ResultCreateSubscriptionRequiresActionResponse",
+    "ResultCreateSubscriptionRequiresActionResponseAction",
+    "ResultCreateSubscriptionSuccessResponse",
+]
+
+
+class ResultCreateSubscriptionRequiresActionResponseAction(BaseModel):
+    """The action to take to complete the request."""
+
+    checkout_url: str
+    """The URL of the checkout page to redirect to in order to complete the request."""
+
+    requires_action_type: Literal["checkout"]
+
+
+class ResultCreateSubscriptionRequiresActionResponse(BaseModel):
+    action: ResultCreateSubscriptionRequiresActionResponseAction
+    """The action to take to complete the request."""
+
+    result_type: Literal["requires_action"]
+
+
+class ResultCreateSubscriptionSuccessResponse(BaseModel):
+    result_type: Literal["success"]
+
+    subscription: SubscriptionResource
+    """The created subscription resource."""
+
+
+Result: TypeAlias = Annotated[
+    Union[ResultCreateSubscriptionRequiresActionResponse, ResultCreateSubscriptionSuccessResponse],
+    PropertyInfo(discriminator="result_type"),
+]
+
+
+class SubscriptionCreateResponse(BaseModel):
+    result: Result
+    """The result of the request.
+
+    If the request is successful, the subscription resource will be returned. If the
+    request is requires action, the action to take to complete the request will be
+    returned.
+    """

lark/types/subscription_list_params.py

@@ -0,0 +1,26 @@
+# 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 TypedDict
+
+__all__ = ["SubscriptionListParams"]
+
+
+class SubscriptionListParams(TypedDict, total=False):
+    limit: int
+
+    offset: int
+
+    rate_card_id: Optional[str]
+    """The ID of the rate card to list subscriptions for.
+
+    Cannot be used with subject_id.
+    """
+
+    subject_id: Optional[str]
+    """The ID or external ID of the subject to list subscriptions for.
+
+    Cannot be used with rate_card_id.
+    """

lark/types/subscription_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 .subscription_resource import SubscriptionResource
+
+__all__ = ["SubscriptionListResponse"]
+
+
+class SubscriptionListResponse(BaseModel):
+    has_more: bool
+
+    subscriptions: List[SubscriptionResource]

lark/types/subscription_resource.py

@@ -0,0 +1,49 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from .._models import BaseModel
+
+__all__ = ["SubscriptionResource", "CurrentPeriod"]
+
+
+class CurrentPeriod(BaseModel):
+    """The current period of the subscription if it is active."""
+
+    end: datetime
+
+    start: datetime
+
+    inclusive_end: Optional[bool] = None
+
+    inclusive_start: Optional[bool] = None
+
+
+class SubscriptionResource(BaseModel):
+    id: str
+    """The ID of the subscription."""
+
+    cancels_at_end_of_cycle: bool
+    """Whether the subscription will be cancelled at the end of the current cycle."""
+
+    current_period: Optional[CurrentPeriod] = None
+    """The current period of the subscription if it is active."""
+
+    cycles_next_at: Optional[datetime] = None
+    """The date and time the next cycle of the subscription will start."""
+
+    effective_at: datetime
+    """The date and time the subscription became effective."""
+
+    metadata: Dict[str, str]
+
+    rate_card_id: str
+    """The ID of the rate card of the subscription."""
+
+    status: Literal["active", "cancelled", "paused"]
+    """The status of the subscription."""
+
+    subject_id: str
+    """The ID of the subject that the subscription is for."""

lark/types/usage_event_create_params.py

@@ -0,0 +1,41 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Dict, Union
+from datetime import datetime
+from typing_extensions import Required, Annotated, TypedDict
+
+from .._utils import PropertyInfo
+
+__all__ = ["UsageEventCreateParams"]
+
+
+class UsageEventCreateParams(TypedDict, total=False):
+    data: Required[Dict[str, Union[str, int]]]
+    """The data of the usage event.
+
+    This should contain any data that is needed to aggregate the usage event.
+    """
+
+    event_name: Required[str]
+    """The name of the event.
+
+    This is used by pricing metrics to aggregate usage events.
+    """
+
+    idempotency_key: Required[str]
+    """The idempotency key for the usage event.
+
+    This ensures that the same event is not processed multiple times.
+    """
+
+    subject_id: Required[str]
+    """The ID or external ID of the subject that the usage event is for."""
+
+    timestamp: Annotated[Union[str, datetime, None], PropertyInfo(format="iso8601")]
+    """The timestamp of the usage event.
+
+    It is highly recommended to provide a timestamp. If not provided, the current
+    timestamp will be used.
+    """