===========================================
Products Module
===========================================

This wrapper class facilitates synchronous integration with Paystack Products API. The Products API allows you to create and manage inventories on your integration.

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


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

    Paystack Product API Reference: `Products`_

    .. py:method:: create_product(name: str, description: str, amount: int, currency: str, unlimited: bool | None = None, quantity: int | None = None)→ PayStackResponse

        Create a product

        :param name: The name of the product
        :type name: str
        :param description: The description of the product
        :type description: str
        :param amount: The amount of the product
        :type amount: int
        :param currency: The currency of the product
        :type currency: str
        :param unlimited: Whether or not the product is unlimited
        :type unlimited: bool, optional
        :param quantity: The quantity of the product
        :type quantity: int, optional

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

    .. py:method:: fetch_product(product_id: str)→ PayStackResponse

        Fetch a product

        :param product_id: The ID of the product
        :type product_id: str

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

    .. py:method:: list_products(per_page: int | None = 50, page: int | None = 1, from_date: date | None = None, to_date: date | None = None)→ PayStackResponse

        List products

        :param per_page: The number of products to return per page. (default: 50)
        :type per_page: int, optional
        :param page: The page to return. (default: 1)
        :type page: int, optional
        :param from_date: The date from which to list products
        :type from_date: date, optional
        :param to_date: The date until which to list products
        :type to_date: date, optional

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

    .. py:method:: update_product(product_id: str, name: str, description: str, amount: int, currency: str, unlimited: bool | None = None, quantity: int | None = None)→ PayStackResponse

        Update a product

        :param product_id: The ID of the product
        :type product_id: str
        :param name: The name of the product
        :type name: str
        :param description: The description of the product
        :type description: str
        :param amount: The amount of the product
        :type amount: int
        :param currency: The currency of the product
        :type currency: str
        :param unlimited: Whether the product is unlimited
        :type unlimited: bool, optional
        :param quantity: The quantity of the product
        :type quantity: int, optional

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


.. _Products: https://paystack.com/docs/api/product/