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

lark/rate_cards/types/__init__.py

@@ -7,8 +7,14 @@ from importlib import import_module
 
 if typing.TYPE_CHECKING:
     from .create_rate_card_request_billing_interval import CreateRateCardRequestBillingInterval
+    from .create_rate_card_request_usage_based_rates_item import (
+        CreateRateCardRequestUsageBasedRatesItem,
+        CreateRateCardRequestUsageBasedRatesItem_Simple,
+    )
 _dynamic_imports: typing.Dict[str, str] = {
-    "CreateRateCardRequestBillingInterval": ".create_rate_card_request_billing_interval"
+    "CreateRateCardRequestBillingInterval": ".create_rate_card_request_billing_interval",
+    "CreateRateCardRequestUsageBasedRatesItem": ".create_rate_card_request_usage_based_rates_item",
+    "CreateRateCardRequestUsageBasedRatesItem_Simple": ".create_rate_card_request_usage_based_rates_item",
 }
 
 
@@ -33,4 +39,8 @@ def __dir__():
     return sorted(lazy_attrs)
 
 
-__all__ = ["CreateRateCardRequestBillingInterval"]
+__all__ = [
+    "CreateRateCardRequestBillingInterval",
+    "CreateRateCardRequestUsageBasedRatesItem",
+    "CreateRateCardRequestUsageBasedRatesItem_Simple",
+]

lark/rate_cards/types/create_rate_card_request_usage_based_rates_item.py

@@ -0,0 +1,30 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from __future__ import annotations
+
+import typing
+
+import pydantic
+from ...core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from ...types.price import Price
+
+
+class CreateRateCardRequestUsageBasedRatesItem_Simple(UniversalBaseModel):
+    usage_based_rate_type: typing.Literal["simple"] = "simple"
+    name: typing.Optional[str] = None
+    description: typing.Optional[str] = None
+    price: Price
+    included_units: typing.Optional[int] = None
+    pricing_metric_id: 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
+
+
+CreateRateCardRequestUsageBasedRatesItem = CreateRateCardRequestUsageBasedRatesItem_Simple

lark/subjects/client.py

@@ -78,12 +78,16 @@ class SubjectsClient:
         Parameters
         ----------
         external_id : typing.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.
 
         name : typing.Optional[str]
+            The name of the subject. Used for display in the dashboard.
 
         email : typing.Optional[str]
+            The email of the subject. Must be a valid email address.
 
         metadata : typing.Optional[typing.Dict[str, str]]
+            Additional metadata about the subject. You may use this to store any custom data about the subject.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -141,7 +145,6 @@ class SubjectsClient:
         self,
         subject_id: str,
         *,
-        external_id: typing.Optional[str] = OMIT,
         name: typing.Optional[str] = OMIT,
         email: typing.Optional[str] = OMIT,
         metadata: typing.Optional[typing.Dict[str, typing.Optional[str]]] = OMIT,
@@ -152,13 +155,14 @@ class SubjectsClient:
         ----------
         subject_id : str
 
-        external_id : typing.Optional[str]
-
         name : typing.Optional[str]
+            The name of the subject. Used for display in the dashboard.
 
         email : typing.Optional[str]
+            The email of the subject. Must be a valid email address.
 
         metadata : typing.Optional[typing.Dict[str, typing.Optional[str]]]
+            Additional metadata about the subject. You may use this to store any custom data about the subject.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -180,12 +184,7 @@ class SubjectsClient:
         )
         """
         _response = self._raw_client.update_subject(
-            subject_id,
-            external_id=external_id,
-            name=name,
-            email=email,
-            metadata=metadata,
-            request_options=request_options,
+            subject_id, name=name, email=email, metadata=metadata, request_options=request_options
         )
         return _response.data
 
@@ -293,12 +292,16 @@ class AsyncSubjectsClient:
         Parameters
         ----------
         external_id : typing.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.
 
         name : typing.Optional[str]
+            The name of the subject. Used for display in the dashboard.
 
         email : typing.Optional[str]
+            The email of the subject. Must be a valid email address.
 
         metadata : typing.Optional[typing.Dict[str, str]]
+            Additional metadata about the subject. You may use this to store any custom data about the subject.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -372,7 +375,6 @@ class AsyncSubjectsClient:
         self,
         subject_id: str,
         *,
-        external_id: typing.Optional[str] = OMIT,
         name: typing.Optional[str] = OMIT,
         email: typing.Optional[str] = OMIT,
         metadata: typing.Optional[typing.Dict[str, typing.Optional[str]]] = OMIT,
@@ -383,13 +385,14 @@ class AsyncSubjectsClient:
         ----------
         subject_id : str
 
-        external_id : typing.Optional[str]
-
         name : typing.Optional[str]
+            The name of the subject. Used for display in the dashboard.
 
         email : typing.Optional[str]
+            The email of the subject. Must be a valid email address.
 
         metadata : typing.Optional[typing.Dict[str, typing.Optional[str]]]
+            Additional metadata about the subject. You may use this to store any custom data about the subject.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -419,12 +422,7 @@ class AsyncSubjectsClient:
         asyncio.run(main())
         """
         _response = await self._raw_client.update_subject(
-            subject_id,
-            external_id=external_id,
-            name=name,
-            email=email,
-            metadata=metadata,
-            request_options=request_options,
+            subject_id, name=name, email=email, metadata=metadata, request_options=request_options
         )
         return _response.data
 

lark/subjects/raw_client.py

@@ -93,12 +93,16 @@ class RawSubjectsClient:
         Parameters
         ----------
         external_id : typing.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.
 
         name : typing.Optional[str]
+            The name of the subject. Used for display in the dashboard.
 
         email : typing.Optional[str]
+            The email of the subject. Must be a valid email address.
 
         metadata : typing.Optional[typing.Dict[str, str]]
+            Additional metadata about the subject. You may use this to store any custom data about the subject.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -200,7 +204,6 @@ class RawSubjectsClient:
         self,
         subject_id: str,
         *,
-        external_id: typing.Optional[str] = OMIT,
         name: typing.Optional[str] = OMIT,
         email: typing.Optional[str] = OMIT,
         metadata: typing.Optional[typing.Dict[str, typing.Optional[str]]] = OMIT,
@@ -211,13 +214,14 @@ class RawSubjectsClient:
         ----------
         subject_id : str
 
-        external_id : typing.Optional[str]
-
         name : typing.Optional[str]
+            The name of the subject. Used for display in the dashboard.
 
         email : typing.Optional[str]
+            The email of the subject. Must be a valid email address.
 
         metadata : typing.Optional[typing.Dict[str, typing.Optional[str]]]
+            Additional metadata about the subject. You may use this to store any custom data about the subject.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -231,7 +235,6 @@ class RawSubjectsClient:
             f"subjects/{jsonable_encoder(subject_id)}",
             method="PUT",
             json={
-                "external_id": external_id,
                 "name": name,
                 "email": email,
                 "metadata": metadata,
@@ -392,12 +395,16 @@ class AsyncRawSubjectsClient:
         Parameters
         ----------
         external_id : typing.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.
 
         name : typing.Optional[str]
+            The name of the subject. Used for display in the dashboard.
 
         email : typing.Optional[str]
+            The email of the subject. Must be a valid email address.
 
         metadata : typing.Optional[typing.Dict[str, str]]
+            Additional metadata about the subject. You may use this to store any custom data about the subject.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -499,7 +506,6 @@ class AsyncRawSubjectsClient:
         self,
         subject_id: str,
         *,
-        external_id: typing.Optional[str] = OMIT,
         name: typing.Optional[str] = OMIT,
         email: typing.Optional[str] = OMIT,
         metadata: typing.Optional[typing.Dict[str, typing.Optional[str]]] = OMIT,
@@ -510,13 +516,14 @@ class AsyncRawSubjectsClient:
         ----------
         subject_id : str
 
-        external_id : typing.Optional[str]
-
         name : typing.Optional[str]
+            The name of the subject. Used for display in the dashboard.
 
         email : typing.Optional[str]
+            The email of the subject. Must be a valid email address.
 
         metadata : typing.Optional[typing.Dict[str, typing.Optional[str]]]
+            Additional metadata about the subject. You may use this to store any custom data about the subject.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -530,7 +537,6 @@ class AsyncRawSubjectsClient:
             f"subjects/{jsonable_encoder(subject_id)}",
             method="PUT",
             json={
-                "external_id": external_id,
                 "name": name,
                 "email": email,
                 "metadata": metadata,

lark/subscriptions/client.py

@@ -77,17 +77,20 @@ class SubscriptionsClient:
         *,
         rate_card_id: str,
         subject_id: str,
-        metadata: typing.Optional[typing.Dict[str, typing.Optional[str]]] = OMIT,
+        metadata: typing.Optional[typing.Dict[str, str]] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> SubscriptionResource:
         """
         Parameters
         ----------
         rate_card_id : str
+            The ID of the rate card to use for the subscription.
 
         subject_id : str
+            The ID of the subject to create the subscription for.
 
-        metadata : typing.Optional[typing.Dict[str, typing.Optional[str]]]
+        metadata : typing.Optional[typing.Dict[str, str]]
+            Additional metadata about the subscription. You may use this to store any custom data about the subscription.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -105,8 +108,8 @@ class SubscriptionsClient:
             api_key="YOUR_API_KEY",
         )
         client.subscriptions.create_subscription(
-            rate_card_id="rate_card_id",
-            subject_id="subject_id",
+            rate_card_id="rc_AJWMxR81jxoRlli6p13uf3JB",
+            subject_id="subj_VyX6Q96h5avMho8O7QWlKeXE",
         )
         """
         _response = self._raw_client.create_subscription(
@@ -144,6 +147,87 @@ class SubscriptionsClient:
         _response = self._raw_client.get_subscription(subscription_id, request_options=request_options)
         return _response.data
 
+    def cancel_subscription(
+        self,
+        subscription_id: str,
+        *,
+        reason: typing.Optional[str] = OMIT,
+        cancel_at_end_of_cycle: typing.Optional[bool] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> SubscriptionResource:
+        """
+        Parameters
+        ----------
+        subscription_id : str
+
+        reason : typing.Optional[str]
+            The reason for cancelling the subscription.
+
+        cancel_at_end_of_cycle : typing.Optional[bool]
+            Whether to cancel the subscription at end of cycle.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        SubscriptionResource
+            Successful Response
+
+        Examples
+        --------
+        from lark import Lark
+
+        client = Lark(
+            api_key="YOUR_API_KEY",
+        )
+        client.subscriptions.cancel_subscription(
+            subscription_id="subscription_id",
+        )
+        """
+        _response = self._raw_client.cancel_subscription(
+            subscription_id,
+            reason=reason,
+            cancel_at_end_of_cycle=cancel_at_end_of_cycle,
+            request_options=request_options,
+        )
+        return _response.data
+
+    def change_subscription_rate_card(
+        self, subscription_id: str, *, rate_card_id: str, request_options: typing.Optional[RequestOptions] = None
+    ) -> SubscriptionResource:
+        """
+        Parameters
+        ----------
+        subscription_id : str
+
+        rate_card_id : str
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        SubscriptionResource
+            Successful Response
+
+        Examples
+        --------
+        from lark import Lark
+
+        client = Lark(
+            api_key="YOUR_API_KEY",
+        )
+        client.subscriptions.change_subscription_rate_card(
+            subscription_id="subscription_id",
+            rate_card_id="rc_AJWMxR81jxoRlli6p13uf3JB",
+        )
+        """
+        _response = self._raw_client.change_subscription_rate_card(
+            subscription_id, rate_card_id=rate_card_id, request_options=request_options
+        )
+        return _response.data
+
 
 class AsyncSubscriptionsClient:
     def __init__(self, *, client_wrapper: AsyncClientWrapper):
@@ -218,17 +302,20 @@ class AsyncSubscriptionsClient:
         *,
         rate_card_id: str,
         subject_id: str,
-        metadata: typing.Optional[typing.Dict[str, typing.Optional[str]]] = OMIT,
+        metadata: typing.Optional[typing.Dict[str, str]] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> SubscriptionResource:
         """
         Parameters
         ----------
         rate_card_id : str
+            The ID of the rate card to use for the subscription.
 
         subject_id : str
+            The ID of the subject to create the subscription for.
 
-        metadata : typing.Optional[typing.Dict[str, typing.Optional[str]]]
+        metadata : typing.Optional[typing.Dict[str, str]]
+            Additional metadata about the subscription. You may use this to store any custom data about the subscription.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -251,8 +338,8 @@ class AsyncSubscriptionsClient:
 
         async def main() -> None:
             await client.subscriptions.create_subscription(
-                rate_card_id="rate_card_id",
-                subject_id="subject_id",
+                rate_card_id="rc_AJWMxR81jxoRlli6p13uf3JB",
+                subject_id="subj_VyX6Q96h5avMho8O7QWlKeXE",
             )
 
 
@@ -300,3 +387,100 @@ class AsyncSubscriptionsClient:
         """
         _response = await self._raw_client.get_subscription(subscription_id, request_options=request_options)
         return _response.data
+
+    async def cancel_subscription(
+        self,
+        subscription_id: str,
+        *,
+        reason: typing.Optional[str] = OMIT,
+        cancel_at_end_of_cycle: typing.Optional[bool] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> SubscriptionResource:
+        """
+        Parameters
+        ----------
+        subscription_id : str
+
+        reason : typing.Optional[str]
+            The reason for cancelling the subscription.
+
+        cancel_at_end_of_cycle : typing.Optional[bool]
+            Whether to cancel the subscription at end of cycle.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        SubscriptionResource
+            Successful Response
+
+        Examples
+        --------
+        import asyncio
+
+        from lark import AsyncLark
+
+        client = AsyncLark(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.subscriptions.cancel_subscription(
+                subscription_id="subscription_id",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.cancel_subscription(
+            subscription_id,
+            reason=reason,
+            cancel_at_end_of_cycle=cancel_at_end_of_cycle,
+            request_options=request_options,
+        )
+        return _response.data
+
+    async def change_subscription_rate_card(
+        self, subscription_id: str, *, rate_card_id: str, request_options: typing.Optional[RequestOptions] = None
+    ) -> SubscriptionResource:
+        """
+        Parameters
+        ----------
+        subscription_id : str
+
+        rate_card_id : str
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        SubscriptionResource
+            Successful Response
+
+        Examples
+        --------
+        import asyncio
+
+        from lark import AsyncLark
+
+        client = AsyncLark(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.subscriptions.change_subscription_rate_card(
+                subscription_id="subscription_id",
+                rate_card_id="rc_AJWMxR81jxoRlli6p13uf3JB",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.change_subscription_rate_card(
+            subscription_id, rate_card_id=rate_card_id, request_options=request_options
+        )
+        return _response.data