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

lark/rate_cards/client.py

@@ -4,12 +4,12 @@ import typing
 
 from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
 from ..core.request_options import RequestOptions
-from ..types.create_fixed_rate_interface import CreateFixedRateInterface
-from ..types.create_simple_usage_based_rate_interface import CreateSimpleUsageBasedRateInterface
+from ..types.create_fixed_rate_request import CreateFixedRateRequest
 from ..types.list_rate_cards_response import ListRateCardsResponse
 from ..types.rate_card_resource import RateCardResource
 from .raw_client import AsyncRawRateCardsClient, RawRateCardsClient
 from .types.create_rate_card_request_billing_interval import CreateRateCardRequestBillingInterval
+from .types.create_rate_card_request_usage_based_rates_item import CreateRateCardRequestUsageBasedRatesItem
 
 # this is used as the default value for optional parameters
 OMIT = typing.cast(typing.Any, ...)
@@ -66,8 +66,8 @@ class RateCardsClient:
         name: str,
         billing_interval: CreateRateCardRequestBillingInterval,
         description: typing.Optional[str] = OMIT,
-        usage_based_rates: typing.Optional[typing.Sequence[CreateSimpleUsageBasedRateInterface]] = OMIT,
-        fixed_rates: typing.Optional[typing.Sequence[CreateFixedRateInterface]] = OMIT,
+        fixed_rates: typing.Optional[typing.Sequence[CreateFixedRateRequest]] = OMIT,
+        usage_based_rates: typing.Optional[typing.Sequence[CreateRateCardRequestUsageBasedRatesItem]] = OMIT,
         metadata: typing.Optional[typing.Dict[str, str]] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> RateCardResource:
@@ -75,14 +75,17 @@ class RateCardsClient:
         Parameters
         ----------
         name : str
+            The name of the rate card displayed to the customer.
 
         billing_interval : CreateRateCardRequestBillingInterval
+            How often the customer will be billed for this rate card.
 
         description : typing.Optional[str]
+            The description of the rate card displayed to the customer.
 
-        usage_based_rates : typing.Optional[typing.Sequence[CreateSimpleUsageBasedRateInterface]]
+        fixed_rates : typing.Optional[typing.Sequence[CreateFixedRateRequest]]
 
-        fixed_rates : typing.Optional[typing.Sequence[CreateFixedRateInterface]]
+        usage_based_rates : typing.Optional[typing.Sequence[CreateRateCardRequestUsageBasedRatesItem]]
 
         metadata : typing.Optional[typing.Dict[str, str]]
 
@@ -102,7 +105,7 @@ class RateCardsClient:
             api_key="YOUR_API_KEY",
         )
         client.rate_cards.create_rate_card(
-            name="name",
+            name="Pro Plan",
             billing_interval="monthly",
         )
         """
@@ -110,8 +113,8 @@ class RateCardsClient:
             name=name,
             billing_interval=billing_interval,
             description=description,
-            usage_based_rates=usage_based_rates,
             fixed_rates=fixed_rates,
+            usage_based_rates=usage_based_rates,
             metadata=metadata,
             request_options=request_options,
         )
@@ -207,8 +210,8 @@ class AsyncRateCardsClient:
         name: str,
         billing_interval: CreateRateCardRequestBillingInterval,
         description: typing.Optional[str] = OMIT,
-        usage_based_rates: typing.Optional[typing.Sequence[CreateSimpleUsageBasedRateInterface]] = OMIT,
-        fixed_rates: typing.Optional[typing.Sequence[CreateFixedRateInterface]] = OMIT,
+        fixed_rates: typing.Optional[typing.Sequence[CreateFixedRateRequest]] = OMIT,
+        usage_based_rates: typing.Optional[typing.Sequence[CreateRateCardRequestUsageBasedRatesItem]] = OMIT,
         metadata: typing.Optional[typing.Dict[str, str]] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> RateCardResource:
@@ -216,14 +219,17 @@ class AsyncRateCardsClient:
         Parameters
         ----------
         name : str
+            The name of the rate card displayed to the customer.
 
         billing_interval : CreateRateCardRequestBillingInterval
+            How often the customer will be billed for this rate card.
 
         description : typing.Optional[str]
+            The description of the rate card displayed to the customer.
 
-        usage_based_rates : typing.Optional[typing.Sequence[CreateSimpleUsageBasedRateInterface]]
+        fixed_rates : typing.Optional[typing.Sequence[CreateFixedRateRequest]]
 
-        fixed_rates : typing.Optional[typing.Sequence[CreateFixedRateInterface]]
+        usage_based_rates : typing.Optional[typing.Sequence[CreateRateCardRequestUsageBasedRatesItem]]
 
         metadata : typing.Optional[typing.Dict[str, str]]
 
@@ -248,7 +254,7 @@ class AsyncRateCardsClient:
 
         async def main() -> None:
             await client.rate_cards.create_rate_card(
-                name="name",
+                name="Pro Plan",
                 billing_interval="monthly",
             )
 
@@ -259,8 +265,8 @@ class AsyncRateCardsClient:
             name=name,
             billing_interval=billing_interval,
             description=description,
-            usage_based_rates=usage_based_rates,
             fixed_rates=fixed_rates,
+            usage_based_rates=usage_based_rates,
             metadata=metadata,
             request_options=request_options,
         )

lark/rate_cards/raw_client.py

@@ -11,12 +11,12 @@ from ..core.pydantic_utilities import parse_obj_as
 from ..core.request_options import RequestOptions
 from ..core.serialization import convert_and_respect_annotation_metadata
 from ..errors.unprocessable_entity_error import UnprocessableEntityError
-from ..types.create_fixed_rate_interface import CreateFixedRateInterface
-from ..types.create_simple_usage_based_rate_interface import CreateSimpleUsageBasedRateInterface
+from ..types.create_fixed_rate_request import CreateFixedRateRequest
 from ..types.http_validation_error import HttpValidationError
 from ..types.list_rate_cards_response import ListRateCardsResponse
 from ..types.rate_card_resource import RateCardResource
 from .types.create_rate_card_request_billing_interval import CreateRateCardRequestBillingInterval
+from .types.create_rate_card_request_usage_based_rates_item import CreateRateCardRequestUsageBasedRatesItem
 
 # this is used as the default value for optional parameters
 OMIT = typing.cast(typing.Any, ...)
@@ -82,8 +82,8 @@ class RawRateCardsClient:
         name: str,
         billing_interval: CreateRateCardRequestBillingInterval,
         description: typing.Optional[str] = OMIT,
-        usage_based_rates: typing.Optional[typing.Sequence[CreateSimpleUsageBasedRateInterface]] = OMIT,
-        fixed_rates: typing.Optional[typing.Sequence[CreateFixedRateInterface]] = OMIT,
+        fixed_rates: typing.Optional[typing.Sequence[CreateFixedRateRequest]] = OMIT,
+        usage_based_rates: typing.Optional[typing.Sequence[CreateRateCardRequestUsageBasedRatesItem]] = OMIT,
         metadata: typing.Optional[typing.Dict[str, str]] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> HttpResponse[RateCardResource]:
@@ -91,14 +91,17 @@ class RawRateCardsClient:
         Parameters
         ----------
         name : str
+            The name of the rate card displayed to the customer.
 
         billing_interval : CreateRateCardRequestBillingInterval
+            How often the customer will be billed for this rate card.
 
         description : typing.Optional[str]
+            The description of the rate card displayed to the customer.
 
-        usage_based_rates : typing.Optional[typing.Sequence[CreateSimpleUsageBasedRateInterface]]
+        fixed_rates : typing.Optional[typing.Sequence[CreateFixedRateRequest]]
 
-        fixed_rates : typing.Optional[typing.Sequence[CreateFixedRateInterface]]
+        usage_based_rates : typing.Optional[typing.Sequence[CreateRateCardRequestUsageBasedRatesItem]]
 
         metadata : typing.Optional[typing.Dict[str, str]]
 
@@ -116,15 +119,15 @@ class RawRateCardsClient:
             json={
                 "name": name,
                 "description": description,
+                "billing_interval": billing_interval,
+                "fixed_rates": convert_and_respect_annotation_metadata(
+                    object_=fixed_rates, annotation=typing.Sequence[CreateFixedRateRequest], direction="write"
+                ),
                 "usage_based_rates": convert_and_respect_annotation_metadata(
                     object_=usage_based_rates,
-                    annotation=typing.Sequence[CreateSimpleUsageBasedRateInterface],
+                    annotation=typing.Sequence[CreateRateCardRequestUsageBasedRatesItem],
                     direction="write",
                 ),
-                "fixed_rates": convert_and_respect_annotation_metadata(
-                    object_=fixed_rates, annotation=typing.Sequence[CreateFixedRateInterface], direction="write"
-                ),
-                "billing_interval": billing_interval,
                 "metadata": metadata,
             },
             headers={
@@ -267,8 +270,8 @@ class AsyncRawRateCardsClient:
         name: str,
         billing_interval: CreateRateCardRequestBillingInterval,
         description: typing.Optional[str] = OMIT,
-        usage_based_rates: typing.Optional[typing.Sequence[CreateSimpleUsageBasedRateInterface]] = OMIT,
-        fixed_rates: typing.Optional[typing.Sequence[CreateFixedRateInterface]] = OMIT,
+        fixed_rates: typing.Optional[typing.Sequence[CreateFixedRateRequest]] = OMIT,
+        usage_based_rates: typing.Optional[typing.Sequence[CreateRateCardRequestUsageBasedRatesItem]] = OMIT,
         metadata: typing.Optional[typing.Dict[str, str]] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> AsyncHttpResponse[RateCardResource]:
@@ -276,14 +279,17 @@ class AsyncRawRateCardsClient:
         Parameters
         ----------
         name : str
+            The name of the rate card displayed to the customer.
 
         billing_interval : CreateRateCardRequestBillingInterval
+            How often the customer will be billed for this rate card.
 
         description : typing.Optional[str]
+            The description of the rate card displayed to the customer.
 
-        usage_based_rates : typing.Optional[typing.Sequence[CreateSimpleUsageBasedRateInterface]]
+        fixed_rates : typing.Optional[typing.Sequence[CreateFixedRateRequest]]
 
-        fixed_rates : typing.Optional[typing.Sequence[CreateFixedRateInterface]]
+        usage_based_rates : typing.Optional[typing.Sequence[CreateRateCardRequestUsageBasedRatesItem]]
 
         metadata : typing.Optional[typing.Dict[str, str]]
 
@@ -301,15 +307,15 @@ class AsyncRawRateCardsClient:
             json={
                 "name": name,
                 "description": description,
+                "billing_interval": billing_interval,
+                "fixed_rates": convert_and_respect_annotation_metadata(
+                    object_=fixed_rates, annotation=typing.Sequence[CreateFixedRateRequest], direction="write"
+                ),
                 "usage_based_rates": convert_and_respect_annotation_metadata(
                     object_=usage_based_rates,
-                    annotation=typing.Sequence[CreateSimpleUsageBasedRateInterface],
+                    annotation=typing.Sequence[CreateRateCardRequestUsageBasedRatesItem],
                     direction="write",
                 ),
-                "fixed_rates": convert_and_respect_annotation_metadata(
-                    object_=fixed_rates, annotation=typing.Sequence[CreateFixedRateInterface], direction="write"
-                ),
-                "billing_interval": billing_interval,
                 "metadata": metadata,
             },
             headers={

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: str
+    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,