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

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,88 @@ 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
+            The ID of the rate card to change the subscription to.
+
+        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_jQK2n0wutCj6bBcAIrL6o07g",
+        )
+        """
+        _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 +303,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 +339,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 +388,101 @@ 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
+            The ID of the rate card to change the subscription to.
+
+        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_jQK2n0wutCj6bBcAIrL6o07g",
+            )
+
+
+        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

lark/subscriptions/raw_client.py

@@ -90,17 +90,20 @@ class RawSubscriptionsClient:
         *,
         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,
     ) -> HttpResponse[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.
@@ -197,6 +200,129 @@ class RawSubscriptionsClient:
             raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
         raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
 
+    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,
+    ) -> HttpResponse[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
+        -------
+        HttpResponse[SubscriptionResource]
+            Successful Response
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"subscriptions/{jsonable_encoder(subscription_id)}/cancel",
+            method="POST",
+            json={
+                "reason": reason,
+                "cancel_at_end_of_cycle": cancel_at_end_of_cycle,
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    SubscriptionResource,
+                    parse_obj_as(
+                        type_=SubscriptionResource,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return HttpResponse(response=_response, data=_data)
+            if _response.status_code == 422:
+                raise UnprocessableEntityError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        HttpValidationError,
+                        parse_obj_as(
+                            type_=HttpValidationError,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+    def change_subscription_rate_card(
+        self, subscription_id: str, *, rate_card_id: str, request_options: typing.Optional[RequestOptions] = None
+    ) -> HttpResponse[SubscriptionResource]:
+        """
+        Parameters
+        ----------
+        subscription_id : str
+
+        rate_card_id : str
+            The ID of the rate card to change the subscription to.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        HttpResponse[SubscriptionResource]
+            Successful Response
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"subscriptions/{jsonable_encoder(subscription_id)}/change-rate-card",
+            method="POST",
+            json={
+                "rate_card_id": rate_card_id,
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    SubscriptionResource,
+                    parse_obj_as(
+                        type_=SubscriptionResource,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return HttpResponse(response=_response, data=_data)
+            if _response.status_code == 422:
+                raise UnprocessableEntityError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        HttpValidationError,
+                        parse_obj_as(
+                            type_=HttpValidationError,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
 
 class AsyncRawSubscriptionsClient:
     def __init__(self, *, client_wrapper: AsyncClientWrapper):
@@ -270,17 +396,20 @@ class AsyncRawSubscriptionsClient:
         *,
         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,
     ) -> AsyncHttpResponse[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.
@@ -376,3 +505,126 @@ class AsyncRawSubscriptionsClient:
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
         raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+    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,
+    ) -> AsyncHttpResponse[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
+        -------
+        AsyncHttpResponse[SubscriptionResource]
+            Successful Response
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"subscriptions/{jsonable_encoder(subscription_id)}/cancel",
+            method="POST",
+            json={
+                "reason": reason,
+                "cancel_at_end_of_cycle": cancel_at_end_of_cycle,
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    SubscriptionResource,
+                    parse_obj_as(
+                        type_=SubscriptionResource,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return AsyncHttpResponse(response=_response, data=_data)
+            if _response.status_code == 422:
+                raise UnprocessableEntityError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        HttpValidationError,
+                        parse_obj_as(
+                            type_=HttpValidationError,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+    async def change_subscription_rate_card(
+        self, subscription_id: str, *, rate_card_id: str, request_options: typing.Optional[RequestOptions] = None
+    ) -> AsyncHttpResponse[SubscriptionResource]:
+        """
+        Parameters
+        ----------
+        subscription_id : str
+
+        rate_card_id : str
+            The ID of the rate card to change the subscription to.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncHttpResponse[SubscriptionResource]
+            Successful Response
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"subscriptions/{jsonable_encoder(subscription_id)}/change-rate-card",
+            method="POST",
+            json={
+                "rate_card_id": rate_card_id,
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    SubscriptionResource,
+                    parse_obj_as(
+                        type_=SubscriptionResource,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return AsyncHttpResponse(response=_response, data=_data)
+            if _response.status_code == 422:
+                raise UnprocessableEntityError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        HttpValidationError,
+                        parse_obj_as(
+                            type_=HttpValidationError,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)