pinelabs-python 0.1.0__py3-none-any.whl

pinelabs/orders/client.py

@@ -0,0 +1,613 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ..core.request_options import RequestOptions
+from ..types.amount import Amount
+from ..types.order_response import OrderResponse
+from ..types.split_info import SplitInfo
+from .raw_client import AsyncRawOrdersClient, RawOrdersClient
+from .types.create_order_request_allowed_payment_methods_item import CreateOrderRequestAllowedPaymentMethodsItem
+from .types.create_order_request_purchase_details import CreateOrderRequestPurchaseDetails
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class OrdersClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._raw_client = RawOrdersClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> RawOrdersClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawOrdersClient
+        """
+        return self._raw_client
+
+    def get_order_by_id(
+        self, order_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> OrderResponse:
+        """
+        Retrieve order details using the Pine Labs order identifier.
+
+        Parameters
+        ----------
+        order_id : str
+            Unique Pine Labs order identifier.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        OrderResponse
+            Order retrieved successfully.
+
+        Examples
+        --------
+        from pinelabs import PinelabsApi
+
+        client = PinelabsApi(
+            request_timestamp="YOUR_REQUEST_TIMESTAMP",
+            request_id="YOUR_REQUEST_ID",
+            token="YOUR_TOKEN",
+        )
+        client.orders.get_order_by_id(
+            order_id="v1-5757575757-aa-hU1rUd",
+        )
+        """
+        _response = self._raw_client.get_order_by_id(order_id, request_options=request_options)
+        return _response.data
+
+    def get_order_by_merchant_reference(
+        self, merchant_order_reference: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> OrderResponse:
+        """
+        Retrieve order details using the merchant-assigned order reference.
+
+        Parameters
+        ----------
+        merchant_order_reference : str
+            Unique order reference assigned by the merchant.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        OrderResponse
+            Order retrieved successfully.
+
+        Examples
+        --------
+        from pinelabs import PinelabsApi
+
+        client = PinelabsApi(
+            request_timestamp="YOUR_REQUEST_TIMESTAMP",
+            request_id="YOUR_REQUEST_ID",
+            token="YOUR_TOKEN",
+        )
+        client.orders.get_order_by_merchant_reference(
+            merchant_order_reference="112345",
+        )
+        """
+        _response = self._raw_client.get_order_by_merchant_reference(
+            merchant_order_reference, request_options=request_options
+        )
+        return _response.data
+
+    def capture_order(
+        self,
+        order_id: str,
+        *,
+        merchant_capture_reference: str,
+        capture_amount: typing.Optional[Amount] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> OrderResponse:
+        """
+        Capture a pre-authorized payment. Only applicable when pre_auth is true
+        and a payment is created against the order. Supports one partial capture
+        per order — any remaining amount is auto-reversed.
+
+        Parameters
+        ----------
+        order_id : str
+            Unique Pine Labs order identifier.
+
+        merchant_capture_reference : str
+            Unique identifier for the capture request.
+
+        capture_amount : typing.Optional[Amount]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        OrderResponse
+            Order captured successfully.
+
+        Examples
+        --------
+        from pinelabs import PinelabsApi
+
+        client = PinelabsApi(
+            request_timestamp="YOUR_REQUEST_TIMESTAMP",
+            request_id="YOUR_REQUEST_ID",
+            token="YOUR_TOKEN",
+        )
+        client.orders.capture_order(
+            order_id="v1-5757575757-aa-hU1rUd",
+            merchant_capture_reference="f31d8c60-0dc8-4788-a577-5ced930cc175",
+        )
+        """
+        _response = self._raw_client.capture_order(
+            order_id,
+            merchant_capture_reference=merchant_capture_reference,
+            capture_amount=capture_amount,
+            request_options=request_options,
+        )
+        return _response.data
+
+    def cancel_order(self, order_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> OrderResponse:
+        """
+        Cancel a pre-authorized order. Only applicable when pre_auth is true
+        and a payment is created against the order.
+
+        Parameters
+        ----------
+        order_id : str
+            Unique Pine Labs order identifier.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        OrderResponse
+            Order cancelled successfully.
+
+        Examples
+        --------
+        from pinelabs import PinelabsApi
+
+        client = PinelabsApi(
+            request_timestamp="YOUR_REQUEST_TIMESTAMP",
+            request_id="YOUR_REQUEST_ID",
+            token="YOUR_TOKEN",
+        )
+        client.orders.cancel_order(
+            order_id="v1-5757575757-aa-hU1rUd",
+        )
+        """
+        _response = self._raw_client.cancel_order(order_id, request_options=request_options)
+        return _response.data
+
+    def create_order(
+        self,
+        *,
+        merchant_order_reference: str,
+        order_amount: Amount,
+        pre_auth: typing.Optional[bool] = OMIT,
+        allowed_payment_methods: typing.Optional[typing.Sequence[CreateOrderRequestAllowedPaymentMethodsItem]] = OMIT,
+        notes: typing.Optional[str] = OMIT,
+        callback_url: typing.Optional[str] = OMIT,
+        failure_callback_url: typing.Optional[str] = OMIT,
+        purchase_details: typing.Optional[CreateOrderRequestPurchaseDetails] = OMIT,
+        split_info: typing.Optional[SplitInfo] = OMIT,
+        is_mcc_transaction: typing.Optional[str] = OMIT,
+        base_amount: typing.Optional[Amount] = OMIT,
+        cart_coupon_discount_amount: typing.Optional[Amount] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> OrderResponse:
+        """
+        Create a new payment order. Returns an order with a challenge_url
+        that can be used to redirect the customer for payment.
+
+        This endpoint serves both standard payment orders and affordability
+        suite orders (EMI, Cardless EMI, BNPL). For affordability flows,
+        include `allowed_payment_methods` with values like `CREDIT_EMI`,
+        `DEBIT_EMI`, `CARDLESS_EMI`, or `BNPL`, and optionally provide
+        `cart_coupon_discount_amount`.
+
+        Parameters
+        ----------
+        merchant_order_reference : str
+            **Idempotency Key.** Unique order reference assigned by the merchant. Duplicate requests with the same `merchant_order_reference` will return the existing order instead of creating a new one.
+
+        order_amount : Amount
+
+        pre_auth : typing.Optional[bool]
+            Whether pre-authorization is needed.
+
+        allowed_payment_methods : typing.Optional[typing.Sequence[CreateOrderRequestAllowedPaymentMethodsItem]]
+            Payment methods to offer the customer.
+
+        notes : typing.Optional[str]
+            Note to show against the order.
+
+        callback_url : typing.Optional[str]
+            URL to redirect customers after successful payment.
+
+        failure_callback_url : typing.Optional[str]
+            URL to redirect customers after failed payment. If not provided, callback_url is used for both.
+
+        purchase_details : typing.Optional[CreateOrderRequestPurchaseDetails]
+            Purchase details including customer information.
+
+        split_info : typing.Optional[SplitInfo]
+
+        is_mcc_transaction : typing.Optional[str]
+            Identifies the order type for MCC transactions. Set to "true" for MCC transactions.
+
+        base_amount : typing.Optional[Amount]
+
+        cart_coupon_discount_amount : typing.Optional[Amount]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        OrderResponse
+            Order created successfully.
+
+        Examples
+        --------
+        from pinelabs import Amount, PinelabsApi
+
+        client = PinelabsApi(
+            request_timestamp="YOUR_REQUEST_TIMESTAMP",
+            request_id="YOUR_REQUEST_ID",
+            token="YOUR_TOKEN",
+        )
+        client.orders.create_order(
+            merchant_order_reference="112345",
+            order_amount=Amount(
+                value=50000,
+                currency="INR",
+            ),
+        )
+        """
+        _response = self._raw_client.create_order(
+            merchant_order_reference=merchant_order_reference,
+            order_amount=order_amount,
+            pre_auth=pre_auth,
+            allowed_payment_methods=allowed_payment_methods,
+            notes=notes,
+            callback_url=callback_url,
+            failure_callback_url=failure_callback_url,
+            purchase_details=purchase_details,
+            split_info=split_info,
+            is_mcc_transaction=is_mcc_transaction,
+            base_amount=base_amount,
+            cart_coupon_discount_amount=cart_coupon_discount_amount,
+            request_options=request_options,
+        )
+        return _response.data
+
+
+class AsyncOrdersClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._raw_client = AsyncRawOrdersClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawOrdersClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawOrdersClient
+        """
+        return self._raw_client
+
+    async def get_order_by_id(
+        self, order_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> OrderResponse:
+        """
+        Retrieve order details using the Pine Labs order identifier.
+
+        Parameters
+        ----------
+        order_id : str
+            Unique Pine Labs order identifier.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        OrderResponse
+            Order retrieved successfully.
+
+        Examples
+        --------
+        import asyncio
+
+        from pinelabs import AsyncPinelabsApi
+
+        client = AsyncPinelabsApi(
+            request_timestamp="YOUR_REQUEST_TIMESTAMP",
+            request_id="YOUR_REQUEST_ID",
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.orders.get_order_by_id(
+                order_id="v1-5757575757-aa-hU1rUd",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.get_order_by_id(order_id, request_options=request_options)
+        return _response.data
+
+    async def get_order_by_merchant_reference(
+        self, merchant_order_reference: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> OrderResponse:
+        """
+        Retrieve order details using the merchant-assigned order reference.
+
+        Parameters
+        ----------
+        merchant_order_reference : str
+            Unique order reference assigned by the merchant.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        OrderResponse
+            Order retrieved successfully.
+
+        Examples
+        --------
+        import asyncio
+
+        from pinelabs import AsyncPinelabsApi
+
+        client = AsyncPinelabsApi(
+            request_timestamp="YOUR_REQUEST_TIMESTAMP",
+            request_id="YOUR_REQUEST_ID",
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.orders.get_order_by_merchant_reference(
+                merchant_order_reference="112345",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.get_order_by_merchant_reference(
+            merchant_order_reference, request_options=request_options
+        )
+        return _response.data
+
+    async def capture_order(
+        self,
+        order_id: str,
+        *,
+        merchant_capture_reference: str,
+        capture_amount: typing.Optional[Amount] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> OrderResponse:
+        """
+        Capture a pre-authorized payment. Only applicable when pre_auth is true
+        and a payment is created against the order. Supports one partial capture
+        per order — any remaining amount is auto-reversed.
+
+        Parameters
+        ----------
+        order_id : str
+            Unique Pine Labs order identifier.
+
+        merchant_capture_reference : str
+            Unique identifier for the capture request.
+
+        capture_amount : typing.Optional[Amount]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        OrderResponse
+            Order captured successfully.
+
+        Examples
+        --------
+        import asyncio
+
+        from pinelabs import AsyncPinelabsApi
+
+        client = AsyncPinelabsApi(
+            request_timestamp="YOUR_REQUEST_TIMESTAMP",
+            request_id="YOUR_REQUEST_ID",
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.orders.capture_order(
+                order_id="v1-5757575757-aa-hU1rUd",
+                merchant_capture_reference="f31d8c60-0dc8-4788-a577-5ced930cc175",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.capture_order(
+            order_id,
+            merchant_capture_reference=merchant_capture_reference,
+            capture_amount=capture_amount,
+            request_options=request_options,
+        )
+        return _response.data
+
+    async def cancel_order(
+        self, order_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> OrderResponse:
+        """
+        Cancel a pre-authorized order. Only applicable when pre_auth is true
+        and a payment is created against the order.
+
+        Parameters
+        ----------
+        order_id : str
+            Unique Pine Labs order identifier.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        OrderResponse
+            Order cancelled successfully.
+
+        Examples
+        --------
+        import asyncio
+
+        from pinelabs import AsyncPinelabsApi
+
+        client = AsyncPinelabsApi(
+            request_timestamp="YOUR_REQUEST_TIMESTAMP",
+            request_id="YOUR_REQUEST_ID",
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.orders.cancel_order(
+                order_id="v1-5757575757-aa-hU1rUd",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.cancel_order(order_id, request_options=request_options)
+        return _response.data
+
+    async def create_order(
+        self,
+        *,
+        merchant_order_reference: str,
+        order_amount: Amount,
+        pre_auth: typing.Optional[bool] = OMIT,
+        allowed_payment_methods: typing.Optional[typing.Sequence[CreateOrderRequestAllowedPaymentMethodsItem]] = OMIT,
+        notes: typing.Optional[str] = OMIT,
+        callback_url: typing.Optional[str] = OMIT,
+        failure_callback_url: typing.Optional[str] = OMIT,
+        purchase_details: typing.Optional[CreateOrderRequestPurchaseDetails] = OMIT,
+        split_info: typing.Optional[SplitInfo] = OMIT,
+        is_mcc_transaction: typing.Optional[str] = OMIT,
+        base_amount: typing.Optional[Amount] = OMIT,
+        cart_coupon_discount_amount: typing.Optional[Amount] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> OrderResponse:
+        """
+        Create a new payment order. Returns an order with a challenge_url
+        that can be used to redirect the customer for payment.
+
+        This endpoint serves both standard payment orders and affordability
+        suite orders (EMI, Cardless EMI, BNPL). For affordability flows,
+        include `allowed_payment_methods` with values like `CREDIT_EMI`,
+        `DEBIT_EMI`, `CARDLESS_EMI`, or `BNPL`, and optionally provide
+        `cart_coupon_discount_amount`.
+
+        Parameters
+        ----------
+        merchant_order_reference : str
+            **Idempotency Key.** Unique order reference assigned by the merchant. Duplicate requests with the same `merchant_order_reference` will return the existing order instead of creating a new one.
+
+        order_amount : Amount
+
+        pre_auth : typing.Optional[bool]
+            Whether pre-authorization is needed.
+
+        allowed_payment_methods : typing.Optional[typing.Sequence[CreateOrderRequestAllowedPaymentMethodsItem]]
+            Payment methods to offer the customer.
+
+        notes : typing.Optional[str]
+            Note to show against the order.
+
+        callback_url : typing.Optional[str]
+            URL to redirect customers after successful payment.
+
+        failure_callback_url : typing.Optional[str]
+            URL to redirect customers after failed payment. If not provided, callback_url is used for both.
+
+        purchase_details : typing.Optional[CreateOrderRequestPurchaseDetails]
+            Purchase details including customer information.
+
+        split_info : typing.Optional[SplitInfo]
+
+        is_mcc_transaction : typing.Optional[str]
+            Identifies the order type for MCC transactions. Set to "true" for MCC transactions.
+
+        base_amount : typing.Optional[Amount]
+
+        cart_coupon_discount_amount : typing.Optional[Amount]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        OrderResponse
+            Order created successfully.
+
+        Examples
+        --------
+        import asyncio
+
+        from pinelabs import Amount, AsyncPinelabsApi
+
+        client = AsyncPinelabsApi(
+            request_timestamp="YOUR_REQUEST_TIMESTAMP",
+            request_id="YOUR_REQUEST_ID",
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.orders.create_order(
+                merchant_order_reference="112345",
+                order_amount=Amount(
+                    value=50000,
+                    currency="INR",
+                ),
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.create_order(
+            merchant_order_reference=merchant_order_reference,
+            order_amount=order_amount,
+            pre_auth=pre_auth,
+            allowed_payment_methods=allowed_payment_methods,
+            notes=notes,
+            callback_url=callback_url,
+            failure_callback_url=failure_callback_url,
+            purchase_details=purchase_details,
+            split_info=split_info,
+            is_mcc_transaction=is_mcc_transaction,
+            base_amount=base_amount,
+            cart_coupon_discount_amount=cart_coupon_discount_amount,
+            request_options=request_options,
+        )
+        return _response.data