pinelabs-python 0.1.0__py3-none-any.whl

pinelabs/payment_links/raw_client.py

@@ -0,0 +1,797 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+from json.decoder import JSONDecodeError
+
+from ..core.api_error import ApiError
+from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ..core.http_response import AsyncHttpResponse, HttpResponse
+from ..core.jsonable_encoder import encode_path_param
+from ..core.parse_error import ParsingError
+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.internal_server_error import InternalServerError
+from ..types.amount import Amount
+from ..types.error_response import ErrorResponse
+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 .types.create_payment_link_request_allowed_payment_methods_item import (
+    CreatePaymentLinkRequestAllowedPaymentMethodsItem,
+)
+from pydantic import ValidationError
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class RawPaymentLinksClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    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,
+    ) -> HttpResponse[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
+        -------
+        HttpResponse[PaymentLinkResponse]
+            Payment link created successfully.
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "api/pay/v1/paymentlink",
+            method="POST",
+            json={
+                "amount": convert_and_respect_annotation_metadata(object_=amount, annotation=Amount, direction="write"),
+                "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,
+                "merchant_payment_link_reference": merchant_payment_link_reference,
+                "customer": convert_and_respect_annotation_metadata(
+                    object_=customer, annotation=PaymentLinkCustomer, direction="write"
+                ),
+                "product_details": convert_and_respect_annotation_metadata(
+                    object_=product_details, annotation=typing.Sequence[PaymentLinkProductDetail], direction="write"
+                ),
+                "cart_coupon_discount_amount": convert_and_respect_annotation_metadata(
+                    object_=cart_coupon_discount_amount, annotation=Amount, direction="write"
+                ),
+                "merchant_metadata": merchant_metadata,
+                "split_info": convert_and_respect_annotation_metadata(
+                    object_=split_info, annotation=PaymentLinkSplitInfo, direction="write"
+                ),
+                "account_details": convert_and_respect_annotation_metadata(
+                    object_=account_details, annotation=PaymentLinkAccountDetails, direction="write"
+                ),
+                "callback_url": callback_url,
+                "part_payment": part_payment,
+                "cart_details": convert_and_respect_annotation_metadata(
+                    object_=cart_details, annotation=PaymentLinkCartDetails, direction="write"
+                ),
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    PaymentLinkResponse,
+                    parse_obj_as(
+                        type_=PaymentLinkResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return HttpResponse(response=_response, data=_data)
+            if _response.status_code == 500:
+                raise InternalServerError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # 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)
+        except ValidationError as e:
+            raise ParsingError(
+                status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+            )
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+    def get_payment_link_by_id(
+        self, payment_link_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> HttpResponse[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
+        -------
+        HttpResponse[PaymentLinkResponse]
+            Payment link retrieved successfully.
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"api/pay/v1/paymentlink/{encode_path_param(payment_link_id)}",
+            method="GET",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    PaymentLinkResponse,
+                    parse_obj_as(
+                        type_=PaymentLinkResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return HttpResponse(response=_response, data=_data)
+            if _response.status_code == 500:
+                raise InternalServerError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # 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)
+        except ValidationError as e:
+            raise ParsingError(
+                status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+            )
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+    def get_payment_link_by_merchant_reference(
+        self, merchant_payment_link_reference: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> HttpResponse[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
+        -------
+        HttpResponse[PaymentLinkResponse]
+            Payment link retrieved successfully.
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"api/pay/v1/paymentlink/ref/{encode_path_param(merchant_payment_link_reference)}",
+            method="GET",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    PaymentLinkResponse,
+                    parse_obj_as(
+                        type_=PaymentLinkResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return HttpResponse(response=_response, data=_data)
+            if _response.status_code == 500:
+                raise InternalServerError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # 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)
+        except ValidationError as e:
+            raise ParsingError(
+                status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+            )
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+    def cancel_payment_link(
+        self, payment_link_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> HttpResponse[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
+        -------
+        HttpResponse[PaymentLinkResponse]
+            Payment link cancelled successfully.
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"api/pay/v1/paymentlink/{encode_path_param(payment_link_id)}/cancel",
+            method="PUT",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    PaymentLinkResponse,
+                    parse_obj_as(
+                        type_=PaymentLinkResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return HttpResponse(response=_response, data=_data)
+            if _response.status_code == 500:
+                raise InternalServerError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # 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)
+        except ValidationError as e:
+            raise ParsingError(
+                status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+            )
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+    def resend_payment_link_notification(
+        self, payment_link_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> HttpResponse[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
+        -------
+        HttpResponse[PaymentLinkResponse]
+            Payment link notification resent successfully.
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"api/pay/v1/paymentlink/{encode_path_param(payment_link_id)}/notify",
+            method="PATCH",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    PaymentLinkResponse,
+                    parse_obj_as(
+                        type_=PaymentLinkResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return HttpResponse(response=_response, data=_data)
+            if _response.status_code == 500:
+                raise InternalServerError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # 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)
+        except ValidationError as e:
+            raise ParsingError(
+                status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+            )
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+
+class AsyncRawPaymentLinksClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    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,
+    ) -> AsyncHttpResponse[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
+        -------
+        AsyncHttpResponse[PaymentLinkResponse]
+            Payment link created successfully.
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "api/pay/v1/paymentlink",
+            method="POST",
+            json={
+                "amount": convert_and_respect_annotation_metadata(object_=amount, annotation=Amount, direction="write"),
+                "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,
+                "merchant_payment_link_reference": merchant_payment_link_reference,
+                "customer": convert_and_respect_annotation_metadata(
+                    object_=customer, annotation=PaymentLinkCustomer, direction="write"
+                ),
+                "product_details": convert_and_respect_annotation_metadata(
+                    object_=product_details, annotation=typing.Sequence[PaymentLinkProductDetail], direction="write"
+                ),
+                "cart_coupon_discount_amount": convert_and_respect_annotation_metadata(
+                    object_=cart_coupon_discount_amount, annotation=Amount, direction="write"
+                ),
+                "merchant_metadata": merchant_metadata,
+                "split_info": convert_and_respect_annotation_metadata(
+                    object_=split_info, annotation=PaymentLinkSplitInfo, direction="write"
+                ),
+                "account_details": convert_and_respect_annotation_metadata(
+                    object_=account_details, annotation=PaymentLinkAccountDetails, direction="write"
+                ),
+                "callback_url": callback_url,
+                "part_payment": part_payment,
+                "cart_details": convert_and_respect_annotation_metadata(
+                    object_=cart_details, annotation=PaymentLinkCartDetails, direction="write"
+                ),
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    PaymentLinkResponse,
+                    parse_obj_as(
+                        type_=PaymentLinkResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return AsyncHttpResponse(response=_response, data=_data)
+            if _response.status_code == 500:
+                raise InternalServerError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # 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)
+        except ValidationError as e:
+            raise ParsingError(
+                status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+            )
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+    async def get_payment_link_by_id(
+        self, payment_link_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> AsyncHttpResponse[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
+        -------
+        AsyncHttpResponse[PaymentLinkResponse]
+            Payment link retrieved successfully.
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"api/pay/v1/paymentlink/{encode_path_param(payment_link_id)}",
+            method="GET",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    PaymentLinkResponse,
+                    parse_obj_as(
+                        type_=PaymentLinkResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return AsyncHttpResponse(response=_response, data=_data)
+            if _response.status_code == 500:
+                raise InternalServerError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # 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)
+        except ValidationError as e:
+            raise ParsingError(
+                status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+            )
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+    async def get_payment_link_by_merchant_reference(
+        self, merchant_payment_link_reference: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> AsyncHttpResponse[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
+        -------
+        AsyncHttpResponse[PaymentLinkResponse]
+            Payment link retrieved successfully.
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"api/pay/v1/paymentlink/ref/{encode_path_param(merchant_payment_link_reference)}",
+            method="GET",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    PaymentLinkResponse,
+                    parse_obj_as(
+                        type_=PaymentLinkResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return AsyncHttpResponse(response=_response, data=_data)
+            if _response.status_code == 500:
+                raise InternalServerError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # 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)
+        except ValidationError as e:
+            raise ParsingError(
+                status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+            )
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+    async def cancel_payment_link(
+        self, payment_link_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> AsyncHttpResponse[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
+        -------
+        AsyncHttpResponse[PaymentLinkResponse]
+            Payment link cancelled successfully.
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"api/pay/v1/paymentlink/{encode_path_param(payment_link_id)}/cancel",
+            method="PUT",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    PaymentLinkResponse,
+                    parse_obj_as(
+                        type_=PaymentLinkResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return AsyncHttpResponse(response=_response, data=_data)
+            if _response.status_code == 500:
+                raise InternalServerError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # 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)
+        except ValidationError as e:
+            raise ParsingError(
+                status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+            )
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+    async def resend_payment_link_notification(
+        self, payment_link_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> AsyncHttpResponse[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
+        -------
+        AsyncHttpResponse[PaymentLinkResponse]
+            Payment link notification resent successfully.
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"api/pay/v1/paymentlink/{encode_path_param(payment_link_id)}/notify",
+            method="PATCH",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    PaymentLinkResponse,
+                    parse_obj_as(
+                        type_=PaymentLinkResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return AsyncHttpResponse(response=_response, data=_data)
+            if _response.status_code == 500:
+                raise InternalServerError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # 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)
+        except ValidationError as e:
+            raise ParsingError(
+                status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+            )
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)