paid-python 0.5.0__py3-none-any.whl → 1.0.0a0__py3-none-any.whl

paid/orders/raw_client.py

@@ -1,5 +1,6 @@
 # This file was auto-generated by Fern from our API Definition.
 
+import datetime as dt
 import typing
 from json.decoder import JSONDecodeError
 
@@ -10,8 +11,16 @@ from ..core.jsonable_encoder import jsonable_encoder
 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.bad_request_error import BadRequestError
+from ..errors.forbidden_error import ForbiddenError
+from ..errors.not_found_error import NotFoundError
+from ..types.cancel_renewal_response import CancelRenewalResponse
+from ..types.error import Error
+from ..types.invoice import Invoice
 from ..types.order import Order
 from ..types.order_line_create import OrderLineCreate
+from ..types.proration_attribute_update import ProrationAttributeUpdate
+from ..types.proration_upgrade_response import ProrationUpgradeResponse
 
 # this is used as the default value for optional parameters
 OMIT = typing.cast(typing.Any, ...)
@@ -64,6 +73,7 @@ class RawOrdersClient:
         billing_contact_id: typing.Optional[str] = OMIT,
         description: typing.Optional[str] = OMIT,
         end_date: typing.Optional[str] = OMIT,
+        plan_id: typing.Optional[str] = OMIT,
         order_lines: typing.Optional[typing.Sequence[OrderLineCreate]] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> HttpResponse[Order]:
@@ -86,6 +96,9 @@ class RawOrdersClient:
 
         end_date : typing.Optional[str]
 
+        plan_id : typing.Optional[str]
+            Optional plan ID to associate with this order
+
         order_lines : typing.Optional[typing.Sequence[OrderLineCreate]]
 
         request_options : typing.Optional[RequestOptions]
@@ -108,6 +121,7 @@ class RawOrdersClient:
                 "startDate": start_date,
                 "endDate": end_date,
                 "currency": currency,
+                "planId": plan_id,
                 "orderLines": convert_and_respect_annotation_metadata(
                     object_=order_lines, annotation=typing.Sequence[OrderLineCreate], direction="write"
                 ),
@@ -229,6 +243,349 @@ class RawOrdersClient:
             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 activate_and_pay(
+        self,
+        order_id: str,
+        *,
+        confirmation_token: str,
+        return_url: str,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> HttpResponse[Order]:
+        """
+        Activates the order and processes the initial payment using the provided Stripe confirmation token.
+
+        Parameters
+        ----------
+        order_id : str
+            The order ID (can be internal ID or display ID)
+
+        confirmation_token : str
+            Stripe confirmation token for the payment method
+
+        return_url : str
+            URL to redirect to after payment processing
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        HttpResponse[Order]
+            Order activated and payment processed successfully
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"orders/{jsonable_encoder(order_id)}/activate-and-pay",
+            method="POST",
+            json={
+                "confirmationToken": confirmation_token,
+                "returnUrl": return_url,
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    Order,
+                    parse_obj_as(
+                        type_=Order,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return HttpResponse(response=_response, data=_data)
+            if _response.status_code == 400:
+                raise BadRequestError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        Error,
+                        parse_obj_as(
+                            type_=Error,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 403:
+                raise ForbiddenError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        Error,
+                        parse_obj_as(
+                            type_=Error,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 404:
+                raise NotFoundError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        Error,
+                        parse_obj_as(
+                            type_=Error,  # 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 cancel_renewal(
+        self,
+        order_id: str,
+        *,
+        order_version: int,
+        cancel_from_date: dt.datetime,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> HttpResponse[CancelRenewalResponse]:
+        """
+        Schedules the cancellation of an order's renewal from a specified date. The order will remain active until the cancellation date.
+
+        Parameters
+        ----------
+        order_id : str
+            The order ID (can be internal ID or display ID)
+
+        order_version : int
+            The current version of the order (for optimistic locking)
+
+        cancel_from_date : dt.datetime
+            The date from which the renewal should be cancelled (ISO 8601 format)
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        HttpResponse[CancelRenewalResponse]
+            Order renewal cancelled successfully
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"orders/{jsonable_encoder(order_id)}/cancel",
+            method="POST",
+            json={
+                "orderVersion": order_version,
+                "cancelFromDate": cancel_from_date,
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    CancelRenewalResponse,
+                    parse_obj_as(
+                        type_=CancelRenewalResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return HttpResponse(response=_response, data=_data)
+            if _response.status_code == 400:
+                raise BadRequestError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        Error,
+                        parse_obj_as(
+                            type_=Error,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 403:
+                raise ForbiddenError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        Error,
+                        parse_obj_as(
+                            type_=Error,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 404:
+                raise NotFoundError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        Error,
+                        parse_obj_as(
+                            type_=Error,  # 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 schedule_plan_change(
+        self,
+        order_id: str,
+        *,
+        order_version: int,
+        effective_date: dt.datetime,
+        updated_order_line_attributes: typing.Sequence[ProrationAttributeUpdate],
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> HttpResponse[ProrationUpgradeResponse]:
+        """
+        Schedules a plan upgrade or downgrade for an order with automatic proration calculation. Credits are applied for the unused portion of the current billing period.
+
+        Parameters
+        ----------
+        order_id : str
+            The order ID (can be internal ID or display ID)
+
+        order_version : int
+            The current version of the order (for optimistic locking)
+
+        effective_date : dt.datetime
+            The date when the plan change should take effect (ISO 8601 format)
+
+        updated_order_line_attributes : typing.Sequence[ProrationAttributeUpdate]
+            The list of order line attributes to update
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        HttpResponse[ProrationUpgradeResponse]
+            Plan change scheduled successfully
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"orders/{jsonable_encoder(order_id)}/schedule-plan-change",
+            method="POST",
+            json={
+                "orderVersion": order_version,
+                "effectiveDate": effective_date,
+                "updatedOrderLineAttributes": convert_and_respect_annotation_metadata(
+                    object_=updated_order_line_attributes,
+                    annotation=typing.Sequence[ProrationAttributeUpdate],
+                    direction="write",
+                ),
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    ProrationUpgradeResponse,
+                    parse_obj_as(
+                        type_=ProrationUpgradeResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return HttpResponse(response=_response, data=_data)
+            if _response.status_code == 400:
+                raise BadRequestError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        Error,
+                        parse_obj_as(
+                            type_=Error,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 403:
+                raise ForbiddenError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        Error,
+                        parse_obj_as(
+                            type_=Error,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 404:
+                raise NotFoundError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        Error,
+                        parse_obj_as(
+                            type_=Error,  # 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 get_invoices(
+        self, order_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> HttpResponse[typing.List[Invoice]]:
+        """
+        Retrieves all invoices associated with a specific order.
+
+        Parameters
+        ----------
+        order_id : str
+            The order ID (can be internal ID or display ID)
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        HttpResponse[typing.List[Invoice]]
+            Success response
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"orders/{jsonable_encoder(order_id)}/invoices",
+            method="GET",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    typing.List[Invoice],
+                    parse_obj_as(
+                        type_=typing.List[Invoice],  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return HttpResponse(response=_response, data=_data)
+            if _response.status_code == 403:
+                raise ForbiddenError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        Error,
+                        parse_obj_as(
+                            type_=Error,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 404:
+                raise NotFoundError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        Error,
+                        parse_obj_as(
+                            type_=Error,  # 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 AsyncRawOrdersClient:
     def __init__(self, *, client_wrapper: AsyncClientWrapper):
@@ -279,6 +636,7 @@ class AsyncRawOrdersClient:
         billing_contact_id: typing.Optional[str] = OMIT,
         description: typing.Optional[str] = OMIT,
         end_date: typing.Optional[str] = OMIT,
+        plan_id: typing.Optional[str] = OMIT,
         order_lines: typing.Optional[typing.Sequence[OrderLineCreate]] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> AsyncHttpResponse[Order]:
@@ -301,6 +659,9 @@ class AsyncRawOrdersClient:
 
         end_date : typing.Optional[str]
 
+        plan_id : typing.Optional[str]
+            Optional plan ID to associate with this order
+
         order_lines : typing.Optional[typing.Sequence[OrderLineCreate]]
 
         request_options : typing.Optional[RequestOptions]
@@ -323,6 +684,7 @@ class AsyncRawOrdersClient:
                 "startDate": start_date,
                 "endDate": end_date,
                 "currency": currency,
+                "planId": plan_id,
                 "orderLines": convert_and_respect_annotation_metadata(
                     object_=order_lines, annotation=typing.Sequence[OrderLineCreate], direction="write"
                 ),
@@ -447,3 +809,346 @@ class AsyncRawOrdersClient:
         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 activate_and_pay(
+        self,
+        order_id: str,
+        *,
+        confirmation_token: str,
+        return_url: str,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> AsyncHttpResponse[Order]:
+        """
+        Activates the order and processes the initial payment using the provided Stripe confirmation token.
+
+        Parameters
+        ----------
+        order_id : str
+            The order ID (can be internal ID or display ID)
+
+        confirmation_token : str
+            Stripe confirmation token for the payment method
+
+        return_url : str
+            URL to redirect to after payment processing
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncHttpResponse[Order]
+            Order activated and payment processed successfully
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"orders/{jsonable_encoder(order_id)}/activate-and-pay",
+            method="POST",
+            json={
+                "confirmationToken": confirmation_token,
+                "returnUrl": return_url,
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    Order,
+                    parse_obj_as(
+                        type_=Order,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return AsyncHttpResponse(response=_response, data=_data)
+            if _response.status_code == 400:
+                raise BadRequestError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        Error,
+                        parse_obj_as(
+                            type_=Error,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 403:
+                raise ForbiddenError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        Error,
+                        parse_obj_as(
+                            type_=Error,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 404:
+                raise NotFoundError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        Error,
+                        parse_obj_as(
+                            type_=Error,  # 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 cancel_renewal(
+        self,
+        order_id: str,
+        *,
+        order_version: int,
+        cancel_from_date: dt.datetime,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> AsyncHttpResponse[CancelRenewalResponse]:
+        """
+        Schedules the cancellation of an order's renewal from a specified date. The order will remain active until the cancellation date.
+
+        Parameters
+        ----------
+        order_id : str
+            The order ID (can be internal ID or display ID)
+
+        order_version : int
+            The current version of the order (for optimistic locking)
+
+        cancel_from_date : dt.datetime
+            The date from which the renewal should be cancelled (ISO 8601 format)
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncHttpResponse[CancelRenewalResponse]
+            Order renewal cancelled successfully
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"orders/{jsonable_encoder(order_id)}/cancel",
+            method="POST",
+            json={
+                "orderVersion": order_version,
+                "cancelFromDate": cancel_from_date,
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    CancelRenewalResponse,
+                    parse_obj_as(
+                        type_=CancelRenewalResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return AsyncHttpResponse(response=_response, data=_data)
+            if _response.status_code == 400:
+                raise BadRequestError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        Error,
+                        parse_obj_as(
+                            type_=Error,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 403:
+                raise ForbiddenError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        Error,
+                        parse_obj_as(
+                            type_=Error,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 404:
+                raise NotFoundError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        Error,
+                        parse_obj_as(
+                            type_=Error,  # 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 schedule_plan_change(
+        self,
+        order_id: str,
+        *,
+        order_version: int,
+        effective_date: dt.datetime,
+        updated_order_line_attributes: typing.Sequence[ProrationAttributeUpdate],
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> AsyncHttpResponse[ProrationUpgradeResponse]:
+        """
+        Schedules a plan upgrade or downgrade for an order with automatic proration calculation. Credits are applied for the unused portion of the current billing period.
+
+        Parameters
+        ----------
+        order_id : str
+            The order ID (can be internal ID or display ID)
+
+        order_version : int
+            The current version of the order (for optimistic locking)
+
+        effective_date : dt.datetime
+            The date when the plan change should take effect (ISO 8601 format)
+
+        updated_order_line_attributes : typing.Sequence[ProrationAttributeUpdate]
+            The list of order line attributes to update
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncHttpResponse[ProrationUpgradeResponse]
+            Plan change scheduled successfully
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"orders/{jsonable_encoder(order_id)}/schedule-plan-change",
+            method="POST",
+            json={
+                "orderVersion": order_version,
+                "effectiveDate": effective_date,
+                "updatedOrderLineAttributes": convert_and_respect_annotation_metadata(
+                    object_=updated_order_line_attributes,
+                    annotation=typing.Sequence[ProrationAttributeUpdate],
+                    direction="write",
+                ),
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    ProrationUpgradeResponse,
+                    parse_obj_as(
+                        type_=ProrationUpgradeResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return AsyncHttpResponse(response=_response, data=_data)
+            if _response.status_code == 400:
+                raise BadRequestError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        Error,
+                        parse_obj_as(
+                            type_=Error,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 403:
+                raise ForbiddenError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        Error,
+                        parse_obj_as(
+                            type_=Error,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 404:
+                raise NotFoundError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        Error,
+                        parse_obj_as(
+                            type_=Error,  # 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 get_invoices(
+        self, order_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> AsyncHttpResponse[typing.List[Invoice]]:
+        """
+        Retrieves all invoices associated with a specific order.
+
+        Parameters
+        ----------
+        order_id : str
+            The order ID (can be internal ID or display ID)
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncHttpResponse[typing.List[Invoice]]
+            Success response
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"orders/{jsonable_encoder(order_id)}/invoices",
+            method="GET",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    typing.List[Invoice],
+                    parse_obj_as(
+                        type_=typing.List[Invoice],  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return AsyncHttpResponse(response=_response, data=_data)
+            if _response.status_code == 403:
+                raise ForbiddenError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        Error,
+                        parse_obj_as(
+                            type_=Error,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 404:
+                raise NotFoundError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        Error,
+                        parse_obj_as(
+                            type_=Error,  # 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)