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

lark/subscriptions/client.py

@@ -1,6 +1,5 @@
 # This file was auto-generated by Fern from our API Definition.
 
-import datetime as dt
 import typing
 
 from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
@@ -32,7 +31,8 @@ class SubscriptionsClient:
         self,
         *,
         limit: typing.Optional[int] = None,
-        offset: typing.Optional[int] = None,
+        subject_id: typing.Optional[str] = None,
+        rate_card_id: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> ListSubscriptionsResponse:
         """
@@ -40,7 +40,11 @@ class SubscriptionsClient:
         ----------
         limit : typing.Optional[int]
 
-        offset : typing.Optional[int]
+        subject_id : typing.Optional[str]
+            The ID of the subject to list subscriptions for. Cannot be used with rate_card_id.
+
+        rate_card_id : typing.Optional[str]
+            The ID of the rate card to list subscriptions for. Cannot be used with subject_id.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -56,14 +60,16 @@ class SubscriptionsClient:
 
         client = Lark(
             api_key="YOUR_API_KEY",
-            base_url="https://yourhost.com/path/to/api",
         )
         client.subscriptions.list_subscriptions(
             limit=1,
-            offset=1,
+            subject_id="subject_id",
+            rate_card_id="rate_card_id",
         )
         """
-        _response = self._raw_client.list_subscriptions(limit=limit, offset=offset, request_options=request_options)
+        _response = self._raw_client.list_subscriptions(
+            limit=limit, subject_id=subject_id, rate_card_id=rate_card_id, request_options=request_options
+        )
         return _response.data
 
     def create_subscription(
@@ -71,23 +77,20 @@ class SubscriptionsClient:
         *,
         rate_card_id: str,
         subject_id: str,
-        effective_at: dt.datetime,
-        variables: typing.Optional[typing.Dict[str, typing.Optional[str]]] = OMIT,
-        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.
 
-        effective_at : dt.datetime
-
-        variables : typing.Optional[typing.Dict[str, typing.Optional[str]]]
-
-        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.
@@ -99,29 +102,18 @@ class SubscriptionsClient:
 
         Examples
         --------
-        import datetime
-
         from lark import Lark
 
         client = Lark(
             api_key="YOUR_API_KEY",
-            base_url="https://yourhost.com/path/to/api",
         )
         client.subscriptions.create_subscription(
-            rate_card_id="rate_card_id",
-            subject_id="subject_id",
-            effective_at=datetime.datetime.fromisoformat(
-                "2024-01-15 09:30:00+00:00",
-            ),
+            rate_card_id="rc_AJWMxR81jxoRlli6p13uf3JB",
+            subject_id="subj_VyX6Q96h5avMho8O7QWlKeXE",
         )
         """
         _response = self._raw_client.create_subscription(
-            rate_card_id=rate_card_id,
-            subject_id=subject_id,
-            effective_at=effective_at,
-            variables=variables,
-            metadata=metadata,
-            request_options=request_options,
+            rate_card_id=rate_card_id, subject_id=subject_id, metadata=metadata, request_options=request_options
         )
         return _response.data
 
@@ -147,7 +139,6 @@ class SubscriptionsClient:
 
         client = Lark(
             api_key="YOUR_API_KEY",
-            base_url="https://yourhost.com/path/to/api",
         )
         client.subscriptions.get_subscription(
             subscription_id="subscription_id",
@@ -157,19 +148,31 @@ class SubscriptionsClient:
         return _response.data
 
     def cancel_subscription(
-        self, subscription_id: str, *, request_options: typing.Optional[RequestOptions] = None
-    ) -> None:
+        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
         -------
-        None
+        SubscriptionResource
+            Successful Response
 
         Examples
         --------
@@ -177,29 +180,36 @@ class SubscriptionsClient:
 
         client = Lark(
             api_key="YOUR_API_KEY",
-            base_url="https://yourhost.com/path/to/api",
         )
         client.subscriptions.cancel_subscription(
             subscription_id="subscription_id",
         )
         """
-        _response = self._raw_client.cancel_subscription(subscription_id, request_options=request_options)
+        _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 update_subscription(
-        self, subscription_id: str, *, request_options: typing.Optional[RequestOptions] = None
-    ) -> None:
+    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
         -------
-        None
+        SubscriptionResource
+            Successful Response
 
         Examples
         --------
@@ -207,13 +217,15 @@ class SubscriptionsClient:
 
         client = Lark(
             api_key="YOUR_API_KEY",
-            base_url="https://yourhost.com/path/to/api",
         )
-        client.subscriptions.update_subscription(
+        client.subscriptions.change_subscription_rate_card(
             subscription_id="subscription_id",
+            rate_card_id="rc_AJWMxR81jxoRlli6p13uf3JB",
         )
         """
-        _response = self._raw_client.update_subscription(subscription_id, request_options=request_options)
+        _response = self._raw_client.change_subscription_rate_card(
+            subscription_id, rate_card_id=rate_card_id, request_options=request_options
+        )
         return _response.data
 
 
@@ -236,7 +248,8 @@ class AsyncSubscriptionsClient:
         self,
         *,
         limit: typing.Optional[int] = None,
-        offset: typing.Optional[int] = None,
+        subject_id: typing.Optional[str] = None,
+        rate_card_id: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> ListSubscriptionsResponse:
         """
@@ -244,7 +257,11 @@ class AsyncSubscriptionsClient:
         ----------
         limit : typing.Optional[int]
 
-        offset : typing.Optional[int]
+        subject_id : typing.Optional[str]
+            The ID of the subject to list subscriptions for. Cannot be used with rate_card_id.
+
+        rate_card_id : typing.Optional[str]
+            The ID of the rate card to list subscriptions for. Cannot be used with subject_id.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -262,21 +279,21 @@ class AsyncSubscriptionsClient:
 
         client = AsyncLark(
             api_key="YOUR_API_KEY",
-            base_url="https://yourhost.com/path/to/api",
         )
 
 
         async def main() -> None:
             await client.subscriptions.list_subscriptions(
                 limit=1,
-                offset=1,
+                subject_id="subject_id",
+                rate_card_id="rate_card_id",
             )
 
 
         asyncio.run(main())
         """
         _response = await self._raw_client.list_subscriptions(
-            limit=limit, offset=offset, request_options=request_options
+            limit=limit, subject_id=subject_id, rate_card_id=rate_card_id, request_options=request_options
         )
         return _response.data
 
@@ -285,23 +302,20 @@ class AsyncSubscriptionsClient:
         *,
         rate_card_id: str,
         subject_id: str,
-        effective_at: dt.datetime,
-        variables: typing.Optional[typing.Dict[str, typing.Optional[str]]] = OMIT,
-        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.
 
-        effective_at : dt.datetime
-
-        variables : typing.Optional[typing.Dict[str, typing.Optional[str]]]
-
-        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.
@@ -314,35 +328,25 @@ class AsyncSubscriptionsClient:
         Examples
         --------
         import asyncio
-        import datetime
 
         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.subscriptions.create_subscription(
-                rate_card_id="rate_card_id",
-                subject_id="subject_id",
-                effective_at=datetime.datetime.fromisoformat(
-                    "2024-01-15 09:30:00+00:00",
-                ),
+                rate_card_id="rc_AJWMxR81jxoRlli6p13uf3JB",
+                subject_id="subj_VyX6Q96h5avMho8O7QWlKeXE",
             )
 
 
         asyncio.run(main())
         """
         _response = await self._raw_client.create_subscription(
-            rate_card_id=rate_card_id,
-            subject_id=subject_id,
-            effective_at=effective_at,
-            variables=variables,
-            metadata=metadata,
-            request_options=request_options,
+            rate_card_id=rate_card_id, subject_id=subject_id, metadata=metadata, request_options=request_options
         )
         return _response.data
 
@@ -370,7 +374,6 @@ class AsyncSubscriptionsClient:
 
         client = AsyncLark(
             api_key="YOUR_API_KEY",
-            base_url="https://yourhost.com/path/to/api",
         )
 
 
@@ -386,19 +389,31 @@ class AsyncSubscriptionsClient:
         return _response.data
 
     async def cancel_subscription(
-        self, subscription_id: str, *, request_options: typing.Optional[RequestOptions] = None
-    ) -> None:
+        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
         -------
-        None
+        SubscriptionResource
+            Successful Response
 
         Examples
         --------
@@ -408,7 +423,6 @@ class AsyncSubscriptionsClient:
 
         client = AsyncLark(
             api_key="YOUR_API_KEY",
-            base_url="https://yourhost.com/path/to/api",
         )
 
 
@@ -420,23 +434,31 @@ class AsyncSubscriptionsClient:
 
         asyncio.run(main())
         """
-        _response = await self._raw_client.cancel_subscription(subscription_id, request_options=request_options)
+        _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 update_subscription(
-        self, subscription_id: str, *, request_options: typing.Optional[RequestOptions] = None
-    ) -> None:
+    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
         -------
-        None
+        SubscriptionResource
+            Successful Response
 
         Examples
         --------
@@ -446,17 +468,19 @@ class AsyncSubscriptionsClient:
 
         client = AsyncLark(
             api_key="YOUR_API_KEY",
-            base_url="https://yourhost.com/path/to/api",
         )
 
 
         async def main() -> None:
-            await client.subscriptions.update_subscription(
+            await client.subscriptions.change_subscription_rate_card(
                 subscription_id="subscription_id",
+                rate_card_id="rc_AJWMxR81jxoRlli6p13uf3JB",
             )
 
 
         asyncio.run(main())
         """
-        _response = await self._raw_client.update_subscription(subscription_id, request_options=request_options)
+        _response = await self._raw_client.change_subscription_rate_card(
+            subscription_id, rate_card_id=rate_card_id, request_options=request_options
+        )
         return _response.data