========================
Async Apple Pay Module
========================


This wrapper class enables asynchronous interaction with the Paystack Apple Pay API.
The Apple Pay API allows you to register your application's top-level domain or subdomain,
enabling customers to make secure payment processing using Apple Pay on IOS and Safari.

To access the Apple Pay API methods, you need to call the ``apple_pay`` instance method from ``AsyncPayStackBase``.

See how to call the instance here: :doc:`apaystack`

------------------------------------------------------------------------------

.. py:class:: AsyncApplePayClientAPI(secret_key: str = None)

    Paystack Apple Pay API Reference: `Apple Pay`_

    .. py:method:: async list_domains(use_cursor: bool | None = False, next_page: int | None = None, previous_page: int | None = None)→ PayStackResponse

        List all domains registered with the Apple Pay API.

        :param use_cursor: Use cursor for pagination (default: False).
        :type use_cursor: bool, optional
        :param next_page: Next page.
        :type next_page: int, optional
        :param previous_page: Previous page.
        :type previous_page: int, optional

        :return: The response from the API.
        :rtype: PayStackResponse object

    .. py:method:: async register_domain(domain_name: str)→ PayStackResponse

        Register a domain with the Apple Pay API.

        :param domain_name: The domain name.
        :type domain_name: str

        :return: The response from the API.
        :rtype: PayStackResponse object

    .. py:method:: async unregister_domain(domain_name: str)→ PayStackResponse

        Unregister a domain with the Apple Pay API.

        :param domain_name: The domain name.
        :type domain_name: str

        :return: The response from the API.
        :rtype: PayStackResponse object


.. _Apple Pay: https://paystack.com/docs/api/apple-pay/

.. important::

    The ``register_domain()`` method can only be called with one domain or subdomain at a time.

**Apple Pay Access**

1. **Requirement**: To use the Apple Pay functionality, you must have access to the Apple Pay endpoint.
2. **Verification**: If you're unsure about your access, please contact Paystack customer service for verification.
3. **Testing Environment**: Apple Pay might not be available on your testing environment. If you're using a testing environment and don't see the Apple Pay channel as an option, switch to a live environment and follow these instructions: https://paystack.com/docs/payments/apple-pay/