pinelabs-python 0.1.0__py3-none-any.whl

pinelabs/pay_by_points/types/check_point_balance_request_payment_option_points_card_details.py

@@ -0,0 +1,32 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ...core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+
+
+class CheckPointBalanceRequestPaymentOptionPointsCardDetails(UniversalBaseModel):
+    card_last4: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Last four digits of the card.
+    """
+
+    card_number: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Card number to check points balance.
+    """
+
+    registered_mobile_number: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Registered mobile number on the card.
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

pinelabs/payment_links/__init__.py

@@ -0,0 +1,34 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+
+import typing
+from importlib import import_module
+
+if typing.TYPE_CHECKING:
+    from .types import CreatePaymentLinkRequestAllowedPaymentMethodsItem
+_dynamic_imports: typing.Dict[str, str] = {"CreatePaymentLinkRequestAllowedPaymentMethodsItem": ".types"}
+
+
+def __getattr__(attr_name: str) -> typing.Any:
+    module_name = _dynamic_imports.get(attr_name)
+    if module_name is None:
+        raise AttributeError(f"No {attr_name} found in _dynamic_imports for module name -> {__name__}")
+    try:
+        module = import_module(module_name, __package__)
+        if module_name == f".{attr_name}":
+            return module
+        else:
+            return getattr(module, attr_name)
+    except ImportError as e:
+        raise ImportError(f"Failed to import {attr_name} from {module_name}: {e}") from e
+    except AttributeError as e:
+        raise AttributeError(f"Failed to get {attr_name} from {module_name}: {e}") from e
+
+
+def __dir__():
+    lazy_attrs = list(_dynamic_imports.keys())
+    return sorted(lazy_attrs)
+
+
+__all__ = ["CreatePaymentLinkRequestAllowedPaymentMethodsItem"]

pinelabs/payment_links/client.py

@@ -0,0 +1,642 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ..core.request_options import RequestOptions
+from ..types.amount import Amount
+from ..types.merchant_metadata import MerchantMetadata
+from ..types.payment_link_account_details import PaymentLinkAccountDetails
+from ..types.payment_link_cart_details import PaymentLinkCartDetails
+from ..types.payment_link_customer import PaymentLinkCustomer
+from ..types.payment_link_product_detail import PaymentLinkProductDetail
+from ..types.payment_link_response import PaymentLinkResponse
+from ..types.payment_link_split_info import PaymentLinkSplitInfo
+from .raw_client import AsyncRawPaymentLinksClient, RawPaymentLinksClient
+from .types.create_payment_link_request_allowed_payment_methods_item import (
+    CreatePaymentLinkRequestAllowedPaymentMethodsItem,
+)
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class PaymentLinksClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._raw_client = RawPaymentLinksClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> RawPaymentLinksClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawPaymentLinksClient
+        """
+        return self._raw_client
+
+    def create_payment_link(
+        self,
+        *,
+        amount: Amount,
+        merchant_payment_link_reference: str,
+        description: typing.Optional[str] = OMIT,
+        expire_by: typing.Optional[dt.datetime] = OMIT,
+        allowed_payment_methods: typing.Optional[
+            typing.Sequence[CreatePaymentLinkRequestAllowedPaymentMethodsItem]
+        ] = OMIT,
+        pre_auth: typing.Optional[str] = OMIT,
+        is_mcc_transaction: typing.Optional[str] = OMIT,
+        failure_callback_url: typing.Optional[str] = OMIT,
+        customer: typing.Optional[PaymentLinkCustomer] = OMIT,
+        product_details: typing.Optional[typing.Sequence[PaymentLinkProductDetail]] = OMIT,
+        cart_coupon_discount_amount: typing.Optional[Amount] = OMIT,
+        merchant_metadata: typing.Optional[MerchantMetadata] = OMIT,
+        split_info: typing.Optional[PaymentLinkSplitInfo] = OMIT,
+        account_details: typing.Optional[PaymentLinkAccountDetails] = OMIT,
+        callback_url: typing.Optional[str] = OMIT,
+        part_payment: typing.Optional[bool] = OMIT,
+        cart_details: typing.Optional[PaymentLinkCartDetails] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> PaymentLinkResponse:
+        """
+        Create a payment link for collecting payments. Ensure that your Merchant ID
+        is configured for Pay by Link, split payments, and pre-authorization before
+        creating a payment link.
+
+        Parameters
+        ----------
+        amount : Amount
+
+        merchant_payment_link_reference : str
+            **Idempotency Key.** Unique identifier for the payment link request. Duplicate requests with the same `merchant_payment_link_reference` will return the existing payment link instead of creating a new one.
+
+        description : typing.Optional[str]
+            Description corresponding to the payment.
+
+        expire_by : typing.Optional[dt.datetime]
+            The desired expiration timestamp for the payment link (ISO 8601 UTC).
+            Must be set within a maximum of 180 days from the current date.
+
+        allowed_payment_methods : typing.Optional[typing.Sequence[CreatePaymentLinkRequestAllowedPaymentMethodsItem]]
+            The type of payment methods you want to offer your customers.
+
+        pre_auth : typing.Optional[str]
+            The pre-authorization type.
+            Possible values: "false" (default), "true".
+
+        is_mcc_transaction : typing.Optional[str]
+            Identifies the Payment Link type.
+            "true": The payment link is processed for a MCC transaction.
+            "false" (default): The payment link is processed for a regular transaction.
+
+        failure_callback_url : typing.Optional[str]
+            URL specifically used to redirect customers to a failure page.
+            If not provided, customers will be redirected to the callback_url for both
+            successful and failed transactions.
+
+        customer : typing.Optional[PaymentLinkCustomer]
+
+        product_details : typing.Optional[typing.Sequence[PaymentLinkProductDetail]]
+            An array of objects that contains the list of products associated with the payment.
+
+        cart_coupon_discount_amount : typing.Optional[Amount]
+
+        merchant_metadata : typing.Optional[MerchantMetadata]
+
+        split_info : typing.Optional[PaymentLinkSplitInfo]
+
+        account_details : typing.Optional[PaymentLinkAccountDetails]
+
+        callback_url : typing.Optional[str]
+            URL to which your customers are redirected based on the order or product details,
+            leading them to either a success or failure page.
+
+        part_payment : typing.Optional[bool]
+            Indicates whether the order is for part payments or full.
+            true: The order created is for a part payment.
+            false: The order is created for a full payment.
+
+        cart_details : typing.Optional[PaymentLinkCartDetails]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        PaymentLinkResponse
+            Payment link created successfully.
+
+        Examples
+        --------
+        from pinelabs import Amount, PinelabsApi
+
+        client = PinelabsApi(
+            request_timestamp="YOUR_REQUEST_TIMESTAMP",
+            request_id="YOUR_REQUEST_ID",
+            token="YOUR_TOKEN",
+        )
+        client.payment_links.create_payment_link(
+            amount=Amount(
+                value=50000,
+                currency="INR",
+            ),
+            merchant_payment_link_reference="1234567890",
+        )
+        """
+        _response = self._raw_client.create_payment_link(
+            amount=amount,
+            merchant_payment_link_reference=merchant_payment_link_reference,
+            description=description,
+            expire_by=expire_by,
+            allowed_payment_methods=allowed_payment_methods,
+            pre_auth=pre_auth,
+            is_mcc_transaction=is_mcc_transaction,
+            failure_callback_url=failure_callback_url,
+            customer=customer,
+            product_details=product_details,
+            cart_coupon_discount_amount=cart_coupon_discount_amount,
+            merchant_metadata=merchant_metadata,
+            split_info=split_info,
+            account_details=account_details,
+            callback_url=callback_url,
+            part_payment=part_payment,
+            cart_details=cart_details,
+            request_options=request_options,
+        )
+        return _response.data
+
+    def get_payment_link_by_id(
+        self, payment_link_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> PaymentLinkResponse:
+        """
+        Retrieve payment link details using the Pine Labs payment link identifier.
+
+        Parameters
+        ----------
+        payment_link_id : str
+            Unique Pine Labs payment link identifier.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        PaymentLinkResponse
+            Payment link retrieved successfully.
+
+        Examples
+        --------
+        from pinelabs import PinelabsApi
+
+        client = PinelabsApi(
+            request_timestamp="YOUR_REQUEST_TIMESTAMP",
+            request_id="YOUR_REQUEST_ID",
+            token="YOUR_TOKEN",
+        )
+        client.payment_links.get_payment_link_by_id(
+            payment_link_id="pl-v1-250306082755-aa-uT0noy",
+        )
+        """
+        _response = self._raw_client.get_payment_link_by_id(payment_link_id, request_options=request_options)
+        return _response.data
+
+    def get_payment_link_by_merchant_reference(
+        self, merchant_payment_link_reference: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> PaymentLinkResponse:
+        """
+        Retrieve payment link details using the merchant-assigned payment link reference.
+
+        Parameters
+        ----------
+        merchant_payment_link_reference : str
+            Unique merchant-assigned payment link reference.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        PaymentLinkResponse
+            Payment link retrieved successfully.
+
+        Examples
+        --------
+        from pinelabs import PinelabsApi
+
+        client = PinelabsApi(
+            request_timestamp="YOUR_REQUEST_TIMESTAMP",
+            request_id="YOUR_REQUEST_ID",
+            token="YOUR_TOKEN",
+        )
+        client.payment_links.get_payment_link_by_merchant_reference(
+            merchant_payment_link_reference="1234567890",
+        )
+        """
+        _response = self._raw_client.get_payment_link_by_merchant_reference(
+            merchant_payment_link_reference, request_options=request_options
+        )
+        return _response.data
+
+    def cancel_payment_link(
+        self, payment_link_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> PaymentLinkResponse:
+        """
+        Cancel an existing payment link by its ID.
+
+        Parameters
+        ----------
+        payment_link_id : str
+            Unique Pine Labs payment link identifier.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        PaymentLinkResponse
+            Payment link cancelled successfully.
+
+        Examples
+        --------
+        from pinelabs import PinelabsApi
+
+        client = PinelabsApi(
+            request_timestamp="YOUR_REQUEST_TIMESTAMP",
+            request_id="YOUR_REQUEST_ID",
+            token="YOUR_TOKEN",
+        )
+        client.payment_links.cancel_payment_link(
+            payment_link_id="pl-v1-250306082755-aa-uT0noy",
+        )
+        """
+        _response = self._raw_client.cancel_payment_link(payment_link_id, request_options=request_options)
+        return _response.data
+
+    def resend_payment_link_notification(
+        self, payment_link_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> PaymentLinkResponse:
+        """
+        Resend the payment link notification to the customer.
+
+        Parameters
+        ----------
+        payment_link_id : str
+            Unique Pine Labs payment link identifier.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        PaymentLinkResponse
+            Payment link notification resent successfully.
+
+        Examples
+        --------
+        from pinelabs import PinelabsApi
+
+        client = PinelabsApi(
+            request_timestamp="YOUR_REQUEST_TIMESTAMP",
+            request_id="YOUR_REQUEST_ID",
+            token="YOUR_TOKEN",
+        )
+        client.payment_links.resend_payment_link_notification(
+            payment_link_id="pl-v1-250306082755-aa-uT0noy",
+        )
+        """
+        _response = self._raw_client.resend_payment_link_notification(payment_link_id, request_options=request_options)
+        return _response.data
+
+
+class AsyncPaymentLinksClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._raw_client = AsyncRawPaymentLinksClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawPaymentLinksClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawPaymentLinksClient
+        """
+        return self._raw_client
+
+    async def create_payment_link(
+        self,
+        *,
+        amount: Amount,
+        merchant_payment_link_reference: str,
+        description: typing.Optional[str] = OMIT,
+        expire_by: typing.Optional[dt.datetime] = OMIT,
+        allowed_payment_methods: typing.Optional[
+            typing.Sequence[CreatePaymentLinkRequestAllowedPaymentMethodsItem]
+        ] = OMIT,
+        pre_auth: typing.Optional[str] = OMIT,
+        is_mcc_transaction: typing.Optional[str] = OMIT,
+        failure_callback_url: typing.Optional[str] = OMIT,
+        customer: typing.Optional[PaymentLinkCustomer] = OMIT,
+        product_details: typing.Optional[typing.Sequence[PaymentLinkProductDetail]] = OMIT,
+        cart_coupon_discount_amount: typing.Optional[Amount] = OMIT,
+        merchant_metadata: typing.Optional[MerchantMetadata] = OMIT,
+        split_info: typing.Optional[PaymentLinkSplitInfo] = OMIT,
+        account_details: typing.Optional[PaymentLinkAccountDetails] = OMIT,
+        callback_url: typing.Optional[str] = OMIT,
+        part_payment: typing.Optional[bool] = OMIT,
+        cart_details: typing.Optional[PaymentLinkCartDetails] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> PaymentLinkResponse:
+        """
+        Create a payment link for collecting payments. Ensure that your Merchant ID
+        is configured for Pay by Link, split payments, and pre-authorization before
+        creating a payment link.
+
+        Parameters
+        ----------
+        amount : Amount
+
+        merchant_payment_link_reference : str
+            **Idempotency Key.** Unique identifier for the payment link request. Duplicate requests with the same `merchant_payment_link_reference` will return the existing payment link instead of creating a new one.
+
+        description : typing.Optional[str]
+            Description corresponding to the payment.
+
+        expire_by : typing.Optional[dt.datetime]
+            The desired expiration timestamp for the payment link (ISO 8601 UTC).
+            Must be set within a maximum of 180 days from the current date.
+
+        allowed_payment_methods : typing.Optional[typing.Sequence[CreatePaymentLinkRequestAllowedPaymentMethodsItem]]
+            The type of payment methods you want to offer your customers.
+
+        pre_auth : typing.Optional[str]
+            The pre-authorization type.
+            Possible values: "false" (default), "true".
+
+        is_mcc_transaction : typing.Optional[str]
+            Identifies the Payment Link type.
+            "true": The payment link is processed for a MCC transaction.
+            "false" (default): The payment link is processed for a regular transaction.
+
+        failure_callback_url : typing.Optional[str]
+            URL specifically used to redirect customers to a failure page.
+            If not provided, customers will be redirected to the callback_url for both
+            successful and failed transactions.
+
+        customer : typing.Optional[PaymentLinkCustomer]
+
+        product_details : typing.Optional[typing.Sequence[PaymentLinkProductDetail]]
+            An array of objects that contains the list of products associated with the payment.
+
+        cart_coupon_discount_amount : typing.Optional[Amount]
+
+        merchant_metadata : typing.Optional[MerchantMetadata]
+
+        split_info : typing.Optional[PaymentLinkSplitInfo]
+
+        account_details : typing.Optional[PaymentLinkAccountDetails]
+
+        callback_url : typing.Optional[str]
+            URL to which your customers are redirected based on the order or product details,
+            leading them to either a success or failure page.
+
+        part_payment : typing.Optional[bool]
+            Indicates whether the order is for part payments or full.
+            true: The order created is for a part payment.
+            false: The order is created for a full payment.
+
+        cart_details : typing.Optional[PaymentLinkCartDetails]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        PaymentLinkResponse
+            Payment link 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.payment_links.create_payment_link(
+                amount=Amount(
+                    value=50000,
+                    currency="INR",
+                ),
+                merchant_payment_link_reference="1234567890",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.create_payment_link(
+            amount=amount,
+            merchant_payment_link_reference=merchant_payment_link_reference,
+            description=description,
+            expire_by=expire_by,
+            allowed_payment_methods=allowed_payment_methods,
+            pre_auth=pre_auth,
+            is_mcc_transaction=is_mcc_transaction,
+            failure_callback_url=failure_callback_url,
+            customer=customer,
+            product_details=product_details,
+            cart_coupon_discount_amount=cart_coupon_discount_amount,
+            merchant_metadata=merchant_metadata,
+            split_info=split_info,
+            account_details=account_details,
+            callback_url=callback_url,
+            part_payment=part_payment,
+            cart_details=cart_details,
+            request_options=request_options,
+        )
+        return _response.data
+
+    async def get_payment_link_by_id(
+        self, payment_link_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> PaymentLinkResponse:
+        """
+        Retrieve payment link details using the Pine Labs payment link identifier.
+
+        Parameters
+        ----------
+        payment_link_id : str
+            Unique Pine Labs payment link identifier.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        PaymentLinkResponse
+            Payment link 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.payment_links.get_payment_link_by_id(
+                payment_link_id="pl-v1-250306082755-aa-uT0noy",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.get_payment_link_by_id(payment_link_id, request_options=request_options)
+        return _response.data
+
+    async def get_payment_link_by_merchant_reference(
+        self, merchant_payment_link_reference: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> PaymentLinkResponse:
+        """
+        Retrieve payment link details using the merchant-assigned payment link reference.
+
+        Parameters
+        ----------
+        merchant_payment_link_reference : str
+            Unique merchant-assigned payment link reference.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        PaymentLinkResponse
+            Payment link 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.payment_links.get_payment_link_by_merchant_reference(
+                merchant_payment_link_reference="1234567890",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.get_payment_link_by_merchant_reference(
+            merchant_payment_link_reference, request_options=request_options
+        )
+        return _response.data
+
+    async def cancel_payment_link(
+        self, payment_link_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> PaymentLinkResponse:
+        """
+        Cancel an existing payment link by its ID.
+
+        Parameters
+        ----------
+        payment_link_id : str
+            Unique Pine Labs payment link identifier.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        PaymentLinkResponse
+            Payment link 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.payment_links.cancel_payment_link(
+                payment_link_id="pl-v1-250306082755-aa-uT0noy",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.cancel_payment_link(payment_link_id, request_options=request_options)
+        return _response.data
+
+    async def resend_payment_link_notification(
+        self, payment_link_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> PaymentLinkResponse:
+        """
+        Resend the payment link notification to the customer.
+
+        Parameters
+        ----------
+        payment_link_id : str
+            Unique Pine Labs payment link identifier.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        PaymentLinkResponse
+            Payment link notification resent 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.payment_links.resend_payment_link_notification(
+                payment_link_id="pl-v1-250306082755-aa-uT0noy",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.resend_payment_link_notification(
+            payment_link_id, request_options=request_options
+        )
+        return _response.data