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

lark/subscriptions/raw_client.py

@@ -1,6 +1,5 @@
 # This file was auto-generated by Fern from our API Definition.
 
-import datetime as dt
 import typing
 from json.decoder import JSONDecodeError
 
@@ -27,7 +26,8 @@ class RawSubscriptionsClient:
         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,
     ) -> HttpResponse[ListSubscriptionsResponse]:
         """
@@ -35,7 +35,11 @@ class RawSubscriptionsClient:
         ----------
         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.
@@ -50,7 +54,8 @@ class RawSubscriptionsClient:
             method="GET",
             params={
                 "limit": limit,
-                "offset": offset,
+                "subject_id": subject_id,
+                "rate_card_id": rate_card_id,
             },
             request_options=request_options,
         )
@@ -85,23 +90,20 @@ class RawSubscriptionsClient:
         *,
         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,
     ) -> 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.
 
-        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.
@@ -117,8 +119,6 @@ class RawSubscriptionsClient:
             json={
                 "rate_card_id": rate_card_id,
                 "subject_id": subject_id,
-                "effective_at": effective_at,
-                "variables": variables,
                 "metadata": metadata,
             },
             headers={
@@ -201,56 +201,122 @@ class RawSubscriptionsClient:
         raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
 
     def cancel_subscription(
-        self, subscription_id: str, *, request_options: typing.Optional[RequestOptions] = None
-    ) -> HttpResponse[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,
+    ) -> 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[None]
+        HttpResponse[SubscriptionResource]
+            Successful Response
         """
         _response = self._client_wrapper.httpx_client.request(
-            f"subscriptions/{jsonable_encoder(subscription_id)}",
-            method="DELETE",
+            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:
-                return HttpResponse(response=_response, data=None)
+                _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 update_subscription(
-        self, subscription_id: str, *, request_options: typing.Optional[RequestOptions] = None
-    ) -> HttpResponse[None]:
+    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
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
         Returns
         -------
-        HttpResponse[None]
+        HttpResponse[SubscriptionResource]
+            Successful Response
         """
         _response = self._client_wrapper.httpx_client.request(
-            f"subscriptions/{jsonable_encoder(subscription_id)}",
-            method="PATCH",
+            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:
-                return HttpResponse(response=_response, data=None)
+                _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)
@@ -265,7 +331,8 @@ class AsyncRawSubscriptionsClient:
         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,
     ) -> AsyncHttpResponse[ListSubscriptionsResponse]:
         """
@@ -273,7 +340,11 @@ class AsyncRawSubscriptionsClient:
         ----------
         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.
@@ -288,7 +359,8 @@ class AsyncRawSubscriptionsClient:
             method="GET",
             params={
                 "limit": limit,
-                "offset": offset,
+                "subject_id": subject_id,
+                "rate_card_id": rate_card_id,
             },
             request_options=request_options,
         )
@@ -323,23 +395,20 @@ class AsyncRawSubscriptionsClient:
         *,
         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,
     ) -> 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.
 
-        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.
@@ -355,8 +424,6 @@ class AsyncRawSubscriptionsClient:
             json={
                 "rate_card_id": rate_card_id,
                 "subject_id": subject_id,
-                "effective_at": effective_at,
-                "variables": variables,
                 "metadata": metadata,
             },
             headers={
@@ -439,56 +506,122 @@ class AsyncRawSubscriptionsClient:
         raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
 
     async def cancel_subscription(
-        self, subscription_id: str, *, request_options: typing.Optional[RequestOptions] = None
-    ) -> AsyncHttpResponse[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,
+    ) -> 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[None]
+        AsyncHttpResponse[SubscriptionResource]
+            Successful Response
         """
         _response = await self._client_wrapper.httpx_client.request(
-            f"subscriptions/{jsonable_encoder(subscription_id)}",
-            method="DELETE",
+            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:
-                return AsyncHttpResponse(response=_response, data=None)
+                _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 update_subscription(
-        self, subscription_id: str, *, request_options: typing.Optional[RequestOptions] = None
-    ) -> AsyncHttpResponse[None]:
+    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
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
         Returns
         -------
-        AsyncHttpResponse[None]
+        AsyncHttpResponse[SubscriptionResource]
+            Successful Response
         """
         _response = await self._client_wrapper.httpx_client.request(
-            f"subscriptions/{jsonable_encoder(subscription_id)}",
-            method="PATCH",
+            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:
-                return AsyncHttpResponse(response=_response, data=None)
+                _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)