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

lark/rate_cards/client.py

@@ -4,22 +4,12 @@ import typing
 
 from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
 from ..core.request_options import RequestOptions
-from ..types.create_credit_grant_interface import CreateCreditGrantInterface
-from ..types.create_fixed_rate_interface import CreateFixedRateInterface
-from ..types.create_rate_card_response import CreateRateCardResponse
-from ..types.create_rate_card_version_response import CreateRateCardVersionResponse
-from ..types.credit_grant_resource import CreditGrantResource
-from ..types.feature_access_resource import FeatureAccessResource
-from ..types.fixed_rate_interface import FixedRateInterface
-from ..types.get_rate_card_response import GetRateCardResponse
+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
-from .types.create_rate_card_version_request_usage_based_rates_item import (
-    CreateRateCardVersionRequestUsageBasedRatesItem,
-)
-from .types.create_rate_card_version_request_version_type import CreateRateCardVersionRequestVersionType
 
 # this is used as the default value for optional parameters
 OMIT = typing.cast(typing.Any, ...)
@@ -41,19 +31,13 @@ class RateCardsClient:
         return self._raw_client
 
     def list_rate_cards(
-        self,
-        *,
-        limit: typing.Optional[int] = None,
-        offset: typing.Optional[int] = None,
-        request_options: typing.Optional[RequestOptions] = None,
+        self, *, limit: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None
     ) -> ListRateCardsResponse:
         """
         Parameters
         ----------
         limit : typing.Optional[int]
 
-        offset : typing.Optional[int]
-
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -68,45 +52,37 @@ class RateCardsClient:
 
         client = Lark(
             api_key="YOUR_API_KEY",
-            base_url="https://yourhost.com/path/to/api",
         )
         client.rate_cards.list_rate_cards(
             limit=1,
-            offset=1,
         )
         """
-        _response = self._raw_client.list_rate_cards(limit=limit, offset=offset, request_options=request_options)
+        _response = self._raw_client.list_rate_cards(limit=limit, request_options=request_options)
         return _response.data
 
     def create_rate_card(
         self,
         *,
         name: str,
-        description: str,
-        usage_based_rates: typing.Sequence[CreateRateCardRequestUsageBasedRatesItem],
         billing_interval: CreateRateCardRequestBillingInterval,
-        fixed_rates: typing.Optional[typing.Sequence[CreateFixedRateInterface]] = OMIT,
-        credit_grants: typing.Optional[typing.Sequence[CreateCreditGrantInterface]] = OMIT,
-        feature_access: typing.Optional[typing.Sequence[FeatureAccessResource]] = OMIT,
+        description: typing.Optional[str] = OMIT,
+        usage_based_rates: typing.Optional[typing.Sequence[CreateRateCardRequestUsageBasedRatesItem]] = OMIT,
+        fixed_rates: typing.Optional[typing.Sequence[CreateFixedRateRequest]] = OMIT,
         metadata: typing.Optional[typing.Dict[str, str]] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> CreateRateCardResponse:
+    ) -> RateCardResource:
         """
         Parameters
         ----------
         name : str
 
-        description : str
-
-        usage_based_rates : typing.Sequence[CreateRateCardRequestUsageBasedRatesItem]
-
         billing_interval : CreateRateCardRequestBillingInterval
 
-        fixed_rates : typing.Optional[typing.Sequence[CreateFixedRateInterface]]
+        description : typing.Optional[str]
 
-        credit_grants : typing.Optional[typing.Sequence[CreateCreditGrantInterface]]
+        usage_based_rates : typing.Optional[typing.Sequence[CreateRateCardRequestUsageBasedRatesItem]]
 
-        feature_access : typing.Optional[typing.Sequence[FeatureAccessResource]]
+        fixed_rates : typing.Optional[typing.Sequence[CreateFixedRateRequest]]
 
         metadata : typing.Optional[typing.Dict[str, str]]
 
@@ -115,77 +91,27 @@ class RateCardsClient:
 
         Returns
         -------
-        CreateRateCardResponse
+        RateCardResource
             Successful Response
 
         Examples
         --------
-        from lark import (
-            Aggregation_Count,
-            CreateDimensionCoordinateInterface,
-            CreateDimensionInterface,
-            CreatePricingMatrixCellInterface,
-            CreatePricingMatrixInterface,
-            CreatePricingMetricInterface,
-            Lark,
-        )
-        from lark.rate_cards import CreateRateCardRequestUsageBasedRatesItem_Dimensional
+        from lark import Lark
 
         client = Lark(
             api_key="YOUR_API_KEY",
-            base_url="https://yourhost.com/path/to/api",
         )
         client.rate_cards.create_rate_card(
             name="name",
-            description="description",
-            usage_based_rates=[
-                CreateRateCardRequestUsageBasedRatesItem_Dimensional(
-                    code="code",
-                    name="name",
-                    pricing_metric=CreatePricingMetricInterface(
-                        name="name",
-                        event_name="event_name",
-                        aggregation=Aggregation_Count(),
-                        unit="unit",
-                    ),
-                    dimensions=[
-                        CreateDimensionInterface(
-                            key="key",
-                            values=["values"],
-                        )
-                    ],
-                    pricing_matrix=CreatePricingMatrixInterface(
-                        cells=[
-                            CreatePricingMatrixCellInterface(
-                                dimension_coordinates=[
-                                    CreateDimensionCoordinateInterface(
-                                        dimension_key="dimension_key",
-                                        value="value",
-                                    )
-                                ],
-                                price={
-                                    "amount": {
-                                        "value": 1,
-                                        "currency_code": "currency_code",
-                                    },
-                                    "price_type": "flat",
-                                },
-                            )
-                        ],
-                    ),
-                )
-            ],
             billing_interval="monthly",
         )
         """
         _response = self._raw_client.create_rate_card(
             name=name,
+            billing_interval=billing_interval,
             description=description,
             usage_based_rates=usage_based_rates,
-            billing_interval=billing_interval,
             fixed_rates=fixed_rates,
-            credit_grants=credit_grants,
-            feature_access=feature_access,
             metadata=metadata,
             request_options=request_options,
         )
@@ -193,7 +119,7 @@ class RateCardsClient:
 
     def get_rate_card(
         self, rate_card_id: str, *, request_options: typing.Optional[RequestOptions] = None
-    ) -> GetRateCardResponse:
+    ) -> RateCardResource:
         """
         Parameters
         ----------
@@ -204,7 +130,7 @@ class RateCardsClient:
 
         Returns
         -------
-        GetRateCardResponse
+        RateCardResource
             Successful Response
 
         Examples
@@ -213,7 +139,6 @@ class RateCardsClient:
 
         client = Lark(
             api_key="YOUR_API_KEY",
-            base_url="https://yourhost.com/path/to/api",
         )
         client.rate_cards.get_rate_card(
             rate_card_id="rate_card_id",
@@ -222,178 +147,6 @@ class RateCardsClient:
         _response = self._raw_client.get_rate_card(rate_card_id, request_options=request_options)
         return _response.data
 
-    def delete_rate_card(self, rate_card_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> None:
-        """
-        Parameters
-        ----------
-        rate_card_id : str
-
-        request_options : typing.Optional[RequestOptions]
-            Request-specific configuration.
-
-        Returns
-        -------
-        None
-
-        Examples
-        --------
-        from lark import Lark
-
-        client = Lark(
-            api_key="YOUR_API_KEY",
-            base_url="https://yourhost.com/path/to/api",
-        )
-        client.rate_cards.delete_rate_card(
-            rate_card_id="rate_card_id",
-        )
-        """
-        _response = self._raw_client.delete_rate_card(rate_card_id, request_options=request_options)
-        return _response.data
-
-    def update_rate_card(self, rate_card_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> None:
-        """
-        Parameters
-        ----------
-        rate_card_id : str
-
-        request_options : typing.Optional[RequestOptions]
-            Request-specific configuration.
-
-        Returns
-        -------
-        None
-
-        Examples
-        --------
-        from lark import Lark
-
-        client = Lark(
-            api_key="YOUR_API_KEY",
-            base_url="https://yourhost.com/path/to/api",
-        )
-        client.rate_cards.update_rate_card(
-            rate_card_id="rate_card_id",
-        )
-        """
-        _response = self._raw_client.update_rate_card(rate_card_id, request_options=request_options)
-        return _response.data
-
-    def create_rate_card_version(
-        self,
-        rate_card_id: str,
-        *,
-        name: str,
-        description: str,
-        usage_based_rates: typing.Sequence[CreateRateCardVersionRequestUsageBasedRatesItem],
-        version_type: CreateRateCardVersionRequestVersionType,
-        fixed_rates: typing.Optional[typing.Sequence[FixedRateInterface]] = OMIT,
-        credit_grants: typing.Optional[typing.Sequence[CreditGrantResource]] = OMIT,
-        request_options: typing.Optional[RequestOptions] = None,
-    ) -> CreateRateCardVersionResponse:
-        """
-        Parameters
-        ----------
-        rate_card_id : str
-
-        name : str
-
-        description : str
-
-        usage_based_rates : typing.Sequence[CreateRateCardVersionRequestUsageBasedRatesItem]
-
-        version_type : CreateRateCardVersionRequestVersionType
-
-        fixed_rates : typing.Optional[typing.Sequence[FixedRateInterface]]
-
-        credit_grants : typing.Optional[typing.Sequence[CreditGrantResource]]
-
-        request_options : typing.Optional[RequestOptions]
-            Request-specific configuration.
-
-        Returns
-        -------
-        CreateRateCardVersionResponse
-            Successful Response
-
-        Examples
-        --------
-        from lark import (
-            Aggregation_Count,
-            DimensionCoordinateInterface,
-            DimensionInterface,
-            Lark,
-            PricingMatrixCellInterface,
-            PricingMatrixInterface,
-            PricingMetricInterface,
-        )
-        from lark.rate_cards import (
-            CreateRateCardVersionRequestUsageBasedRatesItem_Dimensional,
-        )
-
-        client = Lark(
-            api_key="YOUR_API_KEY",
-            base_url="https://yourhost.com/path/to/api",
-        )
-        client.rate_cards.create_rate_card_version(
-            rate_card_id="rate_card_id",
-            name="name",
-            description="description",
-            usage_based_rates=[
-                CreateRateCardVersionRequestUsageBasedRatesItem_Dimensional(
-                    id="id",
-                    code="code",
-                    name="name",
-                    description="description",
-                    included_units=1,
-                    pricing_metric=PricingMetricInterface(
-                        id="id",
-                        name="name",
-                        event_name="event_name",
-                        aggregation=Aggregation_Count(),
-                        unit="unit",
-                    ),
-                    dimensions=[
-                        DimensionInterface(
-                            key="key",
-                            values=["values"],
-                        )
-                    ],
-                    pricing_matrix=PricingMatrixInterface(
-                        cells=[
-                            PricingMatrixCellInterface(
-                                dimension_coordinates=[
-                                    DimensionCoordinateInterface(
-                                        dimension_key="dimension_key",
-                                        value="value",
-                                    )
-                                ],
-                                price={
-                                    "amount": {
-                                        "value": 1,
-                                        "currency_code": "currency_code",
-                                    },
-                                    "price_type": "flat",
-                                },
-                            )
-                        ],
-                    ),
-                )
-            ],
-            version_type="major",
-        )
-        """
-        _response = self._raw_client.create_rate_card_version(
-            rate_card_id,
-            name=name,
-            description=description,
-            usage_based_rates=usage_based_rates,
-            version_type=version_type,
-            fixed_rates=fixed_rates,
-            credit_grants=credit_grants,
-            request_options=request_options,
-        )
-        return _response.data
-
 
 class AsyncRateCardsClient:
     def __init__(self, *, client_wrapper: AsyncClientWrapper):
@@ -411,19 +164,13 @@ class AsyncRateCardsClient:
         return self._raw_client
 
     async def list_rate_cards(
-        self,
-        *,
-        limit: typing.Optional[int] = None,
-        offset: typing.Optional[int] = None,
-        request_options: typing.Optional[RequestOptions] = None,
+        self, *, limit: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None
     ) -> ListRateCardsResponse:
         """
         Parameters
         ----------
         limit : typing.Optional[int]
 
-        offset : typing.Optional[int]
-
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -440,51 +187,43 @@ class AsyncRateCardsClient:
 
         client = AsyncLark(
             api_key="YOUR_API_KEY",
-            base_url="https://yourhost.com/path/to/api",
         )
 
 
         async def main() -> None:
             await client.rate_cards.list_rate_cards(
                 limit=1,
-                offset=1,
             )
 
 
         asyncio.run(main())
         """
-        _response = await self._raw_client.list_rate_cards(limit=limit, offset=offset, request_options=request_options)
+        _response = await self._raw_client.list_rate_cards(limit=limit, request_options=request_options)
         return _response.data
 
     async def create_rate_card(
         self,
         *,
         name: str,
-        description: str,
-        usage_based_rates: typing.Sequence[CreateRateCardRequestUsageBasedRatesItem],
         billing_interval: CreateRateCardRequestBillingInterval,
-        fixed_rates: typing.Optional[typing.Sequence[CreateFixedRateInterface]] = OMIT,
-        credit_grants: typing.Optional[typing.Sequence[CreateCreditGrantInterface]] = OMIT,
-        feature_access: typing.Optional[typing.Sequence[FeatureAccessResource]] = OMIT,
+        description: typing.Optional[str] = OMIT,
+        usage_based_rates: typing.Optional[typing.Sequence[CreateRateCardRequestUsageBasedRatesItem]] = OMIT,
+        fixed_rates: typing.Optional[typing.Sequence[CreateFixedRateRequest]] = OMIT,
         metadata: typing.Optional[typing.Dict[str, str]] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> CreateRateCardResponse:
+    ) -> RateCardResource:
         """
         Parameters
         ----------
         name : str
 
-        description : str
-
-        usage_based_rates : typing.Sequence[CreateRateCardRequestUsageBasedRatesItem]
-
         billing_interval : CreateRateCardRequestBillingInterval
 
-        fixed_rates : typing.Optional[typing.Sequence[CreateFixedRateInterface]]
+        description : typing.Optional[str]
 
-        credit_grants : typing.Optional[typing.Sequence[CreateCreditGrantInterface]]
+        usage_based_rates : typing.Optional[typing.Sequence[CreateRateCardRequestUsageBasedRatesItem]]
 
-        feature_access : typing.Optional[typing.Sequence[FeatureAccessResource]]
+        fixed_rates : typing.Optional[typing.Sequence[CreateFixedRateRequest]]
 
         metadata : typing.Optional[typing.Dict[str, str]]
 
@@ -493,71 +232,23 @@ class AsyncRateCardsClient:
 
         Returns
         -------
-        CreateRateCardResponse
+        RateCardResource
             Successful Response
 
         Examples
         --------
         import asyncio
 
-        from lark import (
-            Aggregation_Count,
-            AsyncLark,
-            CreateDimensionCoordinateInterface,
-            CreateDimensionInterface,
-            CreatePricingMatrixCellInterface,
-            CreatePricingMatrixInterface,
-            CreatePricingMetricInterface,
-        )
-        from lark.rate_cards import CreateRateCardRequestUsageBasedRatesItem_Dimensional
+        from lark import AsyncLark
 
         client = AsyncLark(
             api_key="YOUR_API_KEY",
-            base_url="https://yourhost.com/path/to/api",
         )
 
 
         async def main() -> None:
             await client.rate_cards.create_rate_card(
                 name="name",
-                description="description",
-                usage_based_rates=[
-                    CreateRateCardRequestUsageBasedRatesItem_Dimensional(
-                        code="code",
-                        name="name",
-                        pricing_metric=CreatePricingMetricInterface(
-                            name="name",
-                            event_name="event_name",
-                            aggregation=Aggregation_Count(),
-                            unit="unit",
-                        ),
-                        dimensions=[
-                            CreateDimensionInterface(
-                                key="key",
-                                values=["values"],
-                            )
-                        ],
-                        pricing_matrix=CreatePricingMatrixInterface(
-                            cells=[
-                                CreatePricingMatrixCellInterface(
-                                    dimension_coordinates=[
-                                        CreateDimensionCoordinateInterface(
-                                            dimension_key="dimension_key",
-                                            value="value",
-                                        )
-                                    ],
-                                    price={
-                                        "amount": {
-                                            "value": 1,
-                                            "currency_code": "currency_code",
-                                        },
-                                        "price_type": "flat",
-                                    },
-                                )
-                            ],
-                        ),
-                    )
-                ],
                 billing_interval="monthly",
             )
 
@@ -566,12 +257,10 @@ class AsyncRateCardsClient:
         """
         _response = await self._raw_client.create_rate_card(
             name=name,
+            billing_interval=billing_interval,
             description=description,
             usage_based_rates=usage_based_rates,
-            billing_interval=billing_interval,
             fixed_rates=fixed_rates,
-            credit_grants=credit_grants,
-            feature_access=feature_access,
             metadata=metadata,
             request_options=request_options,
         )
@@ -579,7 +268,7 @@ class AsyncRateCardsClient:
 
     async def get_rate_card(
         self, rate_card_id: str, *, request_options: typing.Optional[RequestOptions] = None
-    ) -> GetRateCardResponse:
+    ) -> RateCardResource:
         """
         Parameters
         ----------
@@ -590,7 +279,7 @@ class AsyncRateCardsClient:
 
         Returns
         -------
-        GetRateCardResponse
+        RateCardResource
             Successful Response
 
         Examples
@@ -601,7 +290,6 @@ class AsyncRateCardsClient:
 
         client = AsyncLark(
             api_key="YOUR_API_KEY",
-            base_url="https://yourhost.com/path/to/api",
         )
 
 
@@ -615,203 +303,3 @@ class AsyncRateCardsClient:
         """
         _response = await self._raw_client.get_rate_card(rate_card_id, request_options=request_options)
         return _response.data
-
-    async def delete_rate_card(
-        self, rate_card_id: str, *, request_options: typing.Optional[RequestOptions] = None
-    ) -> None:
-        """
-        Parameters
-        ----------
-        rate_card_id : str
-
-        request_options : typing.Optional[RequestOptions]
-            Request-specific configuration.
-
-        Returns
-        -------
-        None
-
-        Examples
-        --------
-        import asyncio
-
-        from lark import AsyncLark
-
-        client = AsyncLark(
-            api_key="YOUR_API_KEY",
-            base_url="https://yourhost.com/path/to/api",
-        )
-
-
-        async def main() -> None:
-            await client.rate_cards.delete_rate_card(
-                rate_card_id="rate_card_id",
-            )
-
-
-        asyncio.run(main())
-        """
-        _response = await self._raw_client.delete_rate_card(rate_card_id, request_options=request_options)
-        return _response.data
-
-    async def update_rate_card(
-        self, rate_card_id: str, *, request_options: typing.Optional[RequestOptions] = None
-    ) -> None:
-        """
-        Parameters
-        ----------
-        rate_card_id : str
-
-        request_options : typing.Optional[RequestOptions]
-            Request-specific configuration.
-
-        Returns
-        -------
-        None
-
-        Examples
-        --------
-        import asyncio
-
-        from lark import AsyncLark
-
-        client = AsyncLark(
-            api_key="YOUR_API_KEY",
-            base_url="https://yourhost.com/path/to/api",
-        )
-
-
-        async def main() -> None:
-            await client.rate_cards.update_rate_card(
-                rate_card_id="rate_card_id",
-            )
-
-
-        asyncio.run(main())
-        """
-        _response = await self._raw_client.update_rate_card(rate_card_id, request_options=request_options)
-        return _response.data
-
-    async def create_rate_card_version(
-        self,
-        rate_card_id: str,
-        *,
-        name: str,
-        description: str,
-        usage_based_rates: typing.Sequence[CreateRateCardVersionRequestUsageBasedRatesItem],
-        version_type: CreateRateCardVersionRequestVersionType,
-        fixed_rates: typing.Optional[typing.Sequence[FixedRateInterface]] = OMIT,
-        credit_grants: typing.Optional[typing.Sequence[CreditGrantResource]] = OMIT,
-        request_options: typing.Optional[RequestOptions] = None,
-    ) -> CreateRateCardVersionResponse:
-        """
-        Parameters
-        ----------
-        rate_card_id : str
-
-        name : str
-
-        description : str
-
-        usage_based_rates : typing.Sequence[CreateRateCardVersionRequestUsageBasedRatesItem]
-
-        version_type : CreateRateCardVersionRequestVersionType
-
-        fixed_rates : typing.Optional[typing.Sequence[FixedRateInterface]]
-
-        credit_grants : typing.Optional[typing.Sequence[CreditGrantResource]]
-
-        request_options : typing.Optional[RequestOptions]
-            Request-specific configuration.
-
-        Returns
-        -------
-        CreateRateCardVersionResponse
-            Successful Response
-
-        Examples
-        --------
-        import asyncio
-
-        from lark import (
-            Aggregation_Count,
-            AsyncLark,
-            DimensionCoordinateInterface,
-            DimensionInterface,
-            PricingMatrixCellInterface,
-            PricingMatrixInterface,
-            PricingMetricInterface,
-        )
-        from lark.rate_cards import (
-            CreateRateCardVersionRequestUsageBasedRatesItem_Dimensional,
-        )
-
-        client = AsyncLark(
-            api_key="YOUR_API_KEY",
-            base_url="https://yourhost.com/path/to/api",
-        )
-
-
-        async def main() -> None:
-            await client.rate_cards.create_rate_card_version(
-                rate_card_id="rate_card_id",
-                name="name",
-                description="description",
-                usage_based_rates=[
-                    CreateRateCardVersionRequestUsageBasedRatesItem_Dimensional(
-                        id="id",
-                        code="code",
-                        name="name",
-                        description="description",
-                        included_units=1,
-                        pricing_metric=PricingMetricInterface(
-                            id="id",
-                            name="name",
-                            event_name="event_name",
-                            aggregation=Aggregation_Count(),
-                            unit="unit",
-                        ),
-                        dimensions=[
-                            DimensionInterface(
-                                key="key",
-                                values=["values"],
-                            )
-                        ],
-                        pricing_matrix=PricingMatrixInterface(
-                            cells=[
-                                PricingMatrixCellInterface(
-                                    dimension_coordinates=[
-                                        DimensionCoordinateInterface(
-                                            dimension_key="dimension_key",
-                                            value="value",
-                                        )
-                                    ],
-                                    price={
-                                        "amount": {
-                                            "value": 1,
-                                            "currency_code": "currency_code",
-                                        },
-                                        "price_type": "flat",
-                                    },
-                                )
-                            ],
-                        ),
-                    )
-                ],
-                version_type="major",
-            )
-
-
-        asyncio.run(main())
-        """
-        _response = await self._raw_client.create_rate_card_version(
-            rate_card_id,
-            name=name,
-            description=description,
-            usage_based_rates=usage_based_rates,
-            version_type=version_type,
-            fixed_rates=fixed_rates,
-            credit_grants=credit_grants,
-            request_options=request_options,
-        )
-        return _response.data