pypaystack2 3.0.2__tar.gz → 3.2.0__tar.gz

{pypaystack2-3.0.2 → pypaystack2-3.2.0}/PKG-INFO

@@ -1,17 +1,21 @@
 Metadata-Version: 2.4
 Name: pypaystack2
-Version: 3.0.2
+Version: 3.2.0
 Summary: A developer-friendly client library for Paystack
+Keywords: paystack-python,pypaystack,paystack,paystackapi
+Author: Gbenga Adeyi
 Author-email: Gbenga Adeyi <adeyigbenga005@gmail.com>
 License-Expression: MIT
-License-File: LICENSE
-Keywords: paystack,paystack-python,paystackapi,pypaystack
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
-Requires-Python: >=3.11
 Requires-Dist: httpx>=0.28.1
-Requires-Dist: pydantic>=2.10.6
+Requires-Dist: pydantic>=2.12.5
+Requires-Dist: fastapi[standard]>=0.123.10 ; extra == 'webhook'
+Requires-Dist: ngrok>=1.4.0 ; extra == 'webhook'
+Requires-Dist: python-dotenv>=1.2.1 ; extra == 'webhook'
+Requires-Python: >=3.11
+Provides-Extra: webhook
 Description-Content-Type: text/markdown
 
 # PyPaystack2
@@ -31,6 +35,7 @@ projects. It aims at being developer friendly and easy to use.
 - Synchronous and Asynchronous clients.
 - Pydantic for data modelling.
 - Fees Calculation utilities.
+- Webhook support & utilities (>= v3.1.0).
 
 ## Installation
 
@@ -38,6 +43,10 @@ projects. It aims at being developer friendly and easy to use.
 $ pip install -U pypaystack2
 # or install with uv
 $ uv add pypaystack2
+# For webhook cli
+$ pip install -U "pypaystack2[webhook]"
+or install with uv
+$ uv add "pypaystack2[webhook]"
 ```
 
 ## Usage Preview
@@ -55,7 +64,7 @@ you to provide a secret key. It also does not handle likely exceptions that call
 for network related issues and `ValueError` for validation related issues.
 
 ```bash
-Python 3.11.11 (main, Feb 12 2025, 14:51:05) [Clang 19.1.6 ] on linux
+Python 3.11.13 (main, Sep  2 2025, 14:20:25) [Clang 20.1.4 ] on linux
 Type "help", "copyright", "credits" or "license" for more information.
 >>> from pypaystack2 import __version__
 >>> print(__version__)
@@ -81,59 +90,34 @@ Response(
   message='Subscription successfully created',
   data=Subscription(
     customer=87934333,
-    plan=2237384,
-    integration=630606,
-    domain=<Domain.TEST: 'test'>,
-    start=1741208073,
-    status='active',
-    quantity=1,
-    amount=100000,
-    subscription_code='SUB_4sje2s7kb30m5bt',
-    email_token='uqzg0vneparuxtm',
-    authorization=368220905,
-    easy_cron_id=None,
-    cron_expression='54 20 5 3 *',
-    next_payment_date=datetime.datetime(2026, 3, 5, 20, 54, tzinfo=TzInfo(UTC)),
-    open_invoice=None,
-    invoice_limit=0,
-    id=759264,
-    split_code=None,
-    cancelled_at=None,
-    updated_at=datetime.datetime(2025, 3, 5, 20, 54, 33, tzinfo=TzInfo(UTC)),
-    payments_count=None,
-    most_recent_invoice=None,
-    invoices=None,
-    invoice_history=None),
-  meta=None,
-  type=None,
-  code=None,
-  raw={
-    'status': True,
-    'message': 'Subscription successfully created',
-    'data': {
-      'customer': 87934333,
-      'plan': 2237384,
-      'integration': 630606,
-      'domain': 'test',
-      'start': 1741208073,
-      'status': 'active',
-      'quantity': 1,
-      'amount': 100000,
-      'authorization': 368220905,
-      'invoice_limit': 0,
-      'split_code': None,
-      'metadata': None,
-      'subscription_code': 'SUB_4sje2s7kb30m5bt',
-      'email_token': 'uqzg0vneparuxtm',
-      'id': 759264,
-      'cancelledAt': None,
-      'createdAt': '2025-03-05T20:54:33.000Z',
-      'updatedAt': '2025-03-05T20:54:33.000Z',
-      'cron_expression': '54 20 5 3 *',
-      'next_payment_date': '2026-03-05T20:54:00.000Z',
-      'easy_cron_id': None,
-      'open_invoice': None}
-    })
+    plan=2237384,...
+```
+
+### Webhook
+
+PyPaystack2 now supports verifying the authenticity of a webhook payload and a CLI to make working with webhooks locally
+seamless
+
+#### Verifying a webhook payload
+
+```bash
+Python 3.11.13 (main, Sep  2 2025, 14:20:25) [Clang 20.1.4 ] on linux
+Type "help", "copyright", "credits" or "license" for more information.
+>>> from pypaystack2 import PaystackClient
+>>> client = PaystackClient()
+>>> payload = ... # webhook payload e.g., b'{"event": "customeridentification.success", "data": {"customer_id": 324345768, "customer_code": "CUS_e7urjebaoyk1ze2", "email": "jddae8446e-e54c-42ab-bf37-e5abff14527e@example.com", "identification": {"country": "NG", "type": "bank_account", "bvn": "123*****543", "account_number": "342****22", "bank_code": "121"}}}'
+>>> signature = ... # x-paystack-signature e.g., "5d049eb93c7c71fa098f5215d7297bda401710b62df8b392b9052adf8d1a02ff308f6ca57a1db14ffeabd5b66264e9c42de029b7067b9c71eb9c231fb2a8e383"
+>>> is_verified_webhook_payload = client.is_verified_webhook_payload(payload,signature)
+>>> print(is_verified_webhook_payload)
+True
+```
+
+#### Forward webhook events from paystack to your app running locally
+
+**Note:** This requires that you install `pypaystack2[webhook]`
+
+```bash
+pypaystack2 webhook start-tunnel-server --addr localhost:8000 --ngrok-auth-token
 ```
 
 ## Documentation

{pypaystack2-3.0.2 → pypaystack2-3.2.0}/README.md

@@ -15,6 +15,7 @@ projects. It aims at being developer friendly and easy to use.
 - Synchronous and Asynchronous clients.
 - Pydantic for data modelling.
 - Fees Calculation utilities.
+- Webhook support & utilities (>= v3.1.0).
 
 ## Installation
 
@@ -22,6 +23,10 @@ projects. It aims at being developer friendly and easy to use.
 $ pip install -U pypaystack2
 # or install with uv
 $ uv add pypaystack2
+# For webhook cli
+$ pip install -U "pypaystack2[webhook]"
+or install with uv
+$ uv add "pypaystack2[webhook]"
 ```
 
 ## Usage Preview
@@ -39,7 +44,7 @@ you to provide a secret key. It also does not handle likely exceptions that call
 for network related issues and `ValueError` for validation related issues.
 
 ```bash
-Python 3.11.11 (main, Feb 12 2025, 14:51:05) [Clang 19.1.6 ] on linux
+Python 3.11.13 (main, Sep  2 2025, 14:20:25) [Clang 20.1.4 ] on linux
 Type "help", "copyright", "credits" or "license" for more information.
 >>> from pypaystack2 import __version__
 >>> print(__version__)
@@ -65,59 +70,34 @@ Response(
   message='Subscription successfully created',
   data=Subscription(
     customer=87934333,
-    plan=2237384,
-    integration=630606,
-    domain=<Domain.TEST: 'test'>,
-    start=1741208073,
-    status='active',
-    quantity=1,
-    amount=100000,
-    subscription_code='SUB_4sje2s7kb30m5bt',
-    email_token='uqzg0vneparuxtm',
-    authorization=368220905,
-    easy_cron_id=None,
-    cron_expression='54 20 5 3 *',
-    next_payment_date=datetime.datetime(2026, 3, 5, 20, 54, tzinfo=TzInfo(UTC)),
-    open_invoice=None,
-    invoice_limit=0,
-    id=759264,
-    split_code=None,
-    cancelled_at=None,
-    updated_at=datetime.datetime(2025, 3, 5, 20, 54, 33, tzinfo=TzInfo(UTC)),
-    payments_count=None,
-    most_recent_invoice=None,
-    invoices=None,
-    invoice_history=None),
-  meta=None,
-  type=None,
-  code=None,
-  raw={
-    'status': True,
-    'message': 'Subscription successfully created',
-    'data': {
-      'customer': 87934333,
-      'plan': 2237384,
-      'integration': 630606,
-      'domain': 'test',
-      'start': 1741208073,
-      'status': 'active',
-      'quantity': 1,
-      'amount': 100000,
-      'authorization': 368220905,
-      'invoice_limit': 0,
-      'split_code': None,
-      'metadata': None,
-      'subscription_code': 'SUB_4sje2s7kb30m5bt',
-      'email_token': 'uqzg0vneparuxtm',
-      'id': 759264,
-      'cancelledAt': None,
-      'createdAt': '2025-03-05T20:54:33.000Z',
-      'updatedAt': '2025-03-05T20:54:33.000Z',
-      'cron_expression': '54 20 5 3 *',
-      'next_payment_date': '2026-03-05T20:54:00.000Z',
-      'easy_cron_id': None,
-      'open_invoice': None}
-    })
+    plan=2237384,...
+```
+
+### Webhook
+
+PyPaystack2 now supports verifying the authenticity of a webhook payload and a CLI to make working with webhooks locally
+seamless
+
+#### Verifying a webhook payload
+
+```bash
+Python 3.11.13 (main, Sep  2 2025, 14:20:25) [Clang 20.1.4 ] on linux
+Type "help", "copyright", "credits" or "license" for more information.
+>>> from pypaystack2 import PaystackClient
+>>> client = PaystackClient()
+>>> payload = ... # webhook payload e.g., b'{"event": "customeridentification.success", "data": {"customer_id": 324345768, "customer_code": "CUS_e7urjebaoyk1ze2", "email": "jddae8446e-e54c-42ab-bf37-e5abff14527e@example.com", "identification": {"country": "NG", "type": "bank_account", "bvn": "123*****543", "account_number": "342****22", "bank_code": "121"}}}'
+>>> signature = ... # x-paystack-signature e.g., "5d049eb93c7c71fa098f5215d7297bda401710b62df8b392b9052adf8d1a02ff308f6ca57a1db14ffeabd5b66264e9c42de029b7067b9c71eb9c231fb2a8e383"
+>>> is_verified_webhook_payload = client.is_verified_webhook_payload(payload,signature)
+>>> print(is_verified_webhook_payload)
+True
+```
+
+#### Forward webhook events from paystack to your app running locally
+
+**Note:** This requires that you install `pypaystack2[webhook]`
+
+```bash
+pypaystack2 webhook start-tunnel-server --addr localhost:8000 --ngrok-auth-token
 ```
 
 ## Documentation

pypaystack2-3.2.0/pyproject.toml

@@ -0,0 +1,60 @@
+[project]
+name = "pypaystack2"
+version = "3.2.0"
+description = "A developer-friendly client library for Paystack"
+readme = "README.md"
+license = "MIT"
+authors = [
+    { name = "Gbenga Adeyi", email = "adeyigbenga005@gmail.com" }
+]
+keywords = ["paystack-python", "pypaystack", "paystack", "paystackapi"]
+classifiers = [
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+]
+
+
+requires-python = ">= 3.11"
+dependencies = [
+    "httpx>=0.28.1",
+    "pydantic>=2.12.5",
+]
+
+[project.scripts]
+pypaystack2 = "pypaystack2.cli:cli_app"
+
+[project.optional-dependencies]
+webhook = [
+    "fastapi[standard]>=0.123.10",
+    "ngrok>=1.4.0",
+    "python-dotenv>=1.2.1",
+]
+
+[build-system]
+requires = ["uv_build>=0.9.10,<0.10.0"]
+build-backend = "uv_build"
+
+[dependency-groups]
+dev = [
+    "pre-commit>=4.5.0",
+    { include-group = "format" },
+    { include-group = "test" },
+    { include-group = "coverage" },
+]
+format = [
+    "ruff>=0.14.8",
+]
+test = [
+    "python-dotenv>=1.2.1",
+    "tomli>=2.3.0",
+]
+coverage = []
+doc = [
+    "mike>=2.1.3",
+    "mkdocs>=1.6.1",
+    "mkdocs-glightbox>=0.5.2",
+    "mkdocs-material>=9.7.0",
+    "mkdocstrings>=1.0.0",
+    "mkdocstrings-python>=2.0.1",
+]

{pypaystack2-3.0.2 → pypaystack2-3.2.0}/src/pypaystack2/_metadata.py

@@ -1,5 +1,5 @@
 __title__ = "pypaystack2"
-__version__ = "3.0.2"
+__version__ = "3.2.0"
 __author__ = [{"name": "Gbenga Adeyi", "email": "adeyigbenga005@gmail.com"}]
 __license__ = "MIT"
 __copyright__ = "Copyright 2025."

{pypaystack2-3.0.2 → pypaystack2-3.2.0}/src/pypaystack2/base_clients.py

@@ -1,3 +1,5 @@
+import hashlib
+import hmac
 import logging
 import os
 import re
@@ -6,32 +8,49 @@ from abc import ABC, abstractmethod
 from functools import reduce
 from http import HTTPMethod, HTTPStatus
 from json import JSONDecodeError
-from typing import Type, Any, cast
+from typing import Any, Type, cast
 
 import httpx
-from httpx import NetworkError
+from httpx import HTTPError
 from pydantic import ValidationError
 
 from pypaystack2._metadata import __version__
-from pypaystack2.exceptions import MissingSecretKeyException, ClientNetworkError
+from pypaystack2.exceptions import ClientNetworkError, MissingSecretKeyException
 from pypaystack2.fees_calculation_mixin import FeesCalculationMixin
 from pypaystack2.models import Response
 from pypaystack2.types import PaystackDataModel
 
 logger = logging.getLogger(__name__)
 
-SERIALIZATION_FAILED_WARNING_MESSAGE = """An validation error occurred while trying to serialize the data returned
-by paystack with the pydantic model `%s` but has been allowed to
-fail silently. `Response.data` has been set to `None` but this data is still available in
-`Response.raw`. If the pydantic model that raised this error is from the
-library, It's not your fault, Its either I goofed up in the model definitions
-or the response data doesn't match the model.
-please create an issue at https://github.com/gray-adeyi/pypaystack2/issues
-If you're using a custom pydantic model other than the one from the library,
-please see that your model definitions match the data returned by paystack
-
-These are the validation errors:
-%s
+SERIALIZATION_FAILED_ON_SUCCESSFUL_RESPONSE_WARNING_MESSAGE_TEMPLATE = """\
+A validation error occurred while attempting to deserialize the data returned
+by Paystack using the Pydantic model `{response_data_model_class}`. The error
+was allowed to fail silently. As a result, `Response.data` has been set to
+`None`, but the original payload is still available in `Response.raw`.
+
+If this Pydantic model is provided by the library, this is not your fault—
+either the model definition is incorrect or Paystack returned data that
+does not match the expected schema. In this case, please open an issue at:
+https://github.com/gray-adeyi/pypaystack2/issues
+
+If you are using a custom Pydantic model, ensure that its fields match the
+structure of the data returned by Paystack.
+
+Validation errors:
+{error}
+
+"""
+
+SERIALIZATION_FAILED_ON_FAILURE_RESPONSE_WARNING_TEMPLATE = """\
+Deserializing the response returned by Paystack using the Pydantic model
+`{response_data_model_class}` may fail because the request did not return a
+successful HTTP status code. Instead, Paystack responded with
+`{http_status_code}`, which may indicate a different response schema than the
+one expected for a successful request.
+
+If a serialization error occurs, `Response.data` will be set to `None`, but the
+original response content will still be available in `Response.raw`.
+
 """
 
 # When the function that converts the payload keys that are on in snake_case from
@@ -63,6 +82,19 @@ class AbstractAPIClient(FeesCalculationMixin, ABC):
                 f"or set in env variables as `{self._SECRET_KEY_IN_ENV_KEY}`"
             )
 
+    def is_verified_webhook_payload(self, payload: bytes, signature: str) -> bool:
+        """Checks if the webhook payload is indeed sent by paystack
+
+        Args:
+            payload: is the raw webhook data received that needs validation for authenticity.
+            signature: is the `x-paystack-signature` in the response headers of the
+                response that included the payload
+        """
+        digest = hmac.new(
+            self._secret_key.encode(), payload, hashlib.sha512
+        ).hexdigest()
+        return signature == digest
+
     @abstractmethod
     def _handle_request(
         self,
@@ -123,6 +155,7 @@ class AbstractAPIClient(FeesCalculationMixin, ABC):
         if data := response_body.get("data", None):
             data = self._to_pydantic_model(
                 self._normalize_data(data),
+                raw_response.status_code,
                 response_data_model_class,
                 raise_serialization_exception,
             )
@@ -142,6 +175,7 @@ class AbstractAPIClient(FeesCalculationMixin, ABC):
     def _to_pydantic_model(
         self,
         data: dict[str, Any] | list[Any],
+        http_status_code: int,
         response_data_model_class: Type[PaystackDataModel] | None = None,
         raise_serialization_exception: bool = False,
     ) -> PaystackDataModel | list[PaystackDataModel] | None:
@@ -156,12 +190,21 @@ class AbstractAPIClient(FeesCalculationMixin, ABC):
             if isinstance(data, list):
                 return [response_data_model_class.model_validate(item) for item in data]
         except ValidationError as error:
+            if 200 <= http_status_code <= 299:
+                logger.warning(
+                    SERIALIZATION_FAILED_ON_SUCCESSFUL_RESPONSE_WARNING_MESSAGE_TEMPLATE.format(
+                        response_data_model_class=response_data_model_class, error=error
+                    )
+                )
+            else:
+                logger.warning(
+                    SERIALIZATION_FAILED_ON_FAILURE_RESPONSE_WARNING_TEMPLATE.format(
+                        response_data_model_class=response_data_model_class,
+                        http_status_code=http_status_code,
+                    )
+                )
             if raise_serialization_exception:
                 raise error
-            logger.warning(
-                SERIALIZATION_FAILED_WARNING_MESSAGE
-                % (response_data_model_class, error)
-            )
         return None
 
     def _serialize_request_kwargs(
@@ -244,7 +287,7 @@ class BaseAPIClient(AbstractAPIClient):
 
         try:
             response = http_method_handler(**request_kwargs)  # type: ignore
-        except NetworkError as error:
+        except HTTPError as error:
             raise ClientNetworkError(f"network error occurred: {error}", error)
         return self._deserialize_response(
             response, response_data_model_class, raise_serialization_exception
@@ -284,7 +327,7 @@ class BaseAsyncAPIClient(AbstractAPIClient):
                 raise ValueError("HTTP Request method not recognised or implemented")
             try:
                 response = await http_method_handler(**request_kwargs)
-            except NetworkError as error:
+            except HTTPError as error:
                 raise ClientNetworkError(f"network error occurred: {error}", error)
 
         return self._deserialize_response(

pypaystack2-3.2.0/src/pypaystack2/cli.py

@@ -0,0 +1,21 @@
+from pypaystack2.utils import (
+    WEBHOOK_DEPENDENCY_IMPORT_ERROR_MESSAGE_TEMPLATE,
+    try_import_module,
+)
+from pypaystack2.webhook.cli import webhook_cli_app
+
+# for now only the webhook feature needs the cli from a consumer standpoint so the error message is sufficient
+typer_module = try_import_module(
+    "typer",
+    error_msg=WEBHOOK_DEPENDENCY_IMPORT_ERROR_MESSAGE_TEMPLATE.format(
+        package_name="typer"
+    ),
+)
+
+
+cli_app = typer_module.Typer()
+cli_app.add_typer(
+    webhook_cli_app,
+    name="webhook",
+    help="Webhook CLI app for working with paystack webhooks. Try `pypaystack2 webhook --help`",
+)

{pypaystack2-3.0.2 → pypaystack2-3.2.0}/src/pypaystack2/enums.py

@@ -44,10 +44,13 @@ class Channel(StrEnum):
 
     CARD = "card"
     BANK = "bank"
+    APPLE_PAY = "apple_pay"
     USSD = "ussd"
     QR = "qr"
     MOBILE_MONEY = "mobile_money"
     BANK_TRANSFER = "bank_transfer"
+    EFT = "eft"
+    PAYATTITUDE = "payattitude"
 
 
 class Bearer(StrEnum):

{pypaystack2-3.0.2 → pypaystack2-3.2.0}/src/pypaystack2/main_clients.py

@@ -1,3 +1,9 @@
+from pypaystack2.sub_clients.async_clients.direct_debits import AsyncDirectDebitClient
+from pypaystack2.sub_clients.sync_clients.direct_debits import DirectDebitClient
+from pypaystack2.sub_clients.async_clients.virtual_terminals import (
+    AsyncVirtualTerminalClient,
+)
+from pypaystack2.sub_clients.sync_clients.virtual_terminals import VirtualTerminalClient
 from pypaystack2.base_clients import BaseAPIClient, BaseAsyncAPIClient
 from pypaystack2.sub_clients import (
     ApplePayClient,
@@ -102,6 +108,10 @@ class PaystackClient(BaseAPIClient):
             Transfers control API e.g. `PaystackClient.transfer_control.check_balance`.
         verification: A binding to `VerificationClient` providing methods for interacting Paystack's Verification API
             e.g. `PaystackClient.verification.resolve_account_number`.
+        virtual_terminals: A binding to `VirtualTerminalClient` providing methods for interacting with Paystack's
+            Virtual Terminal API e.g. `VirtualTerminalClient.list`.
+        direct_debits: A binding to `DirectDebitClient` providing methods for interacting with Paystack's
+            Direct Debit API e.g. `DirectDebitClient.trigger_activation_charge`.
     """
 
     def __init__(self, secret_key: str | None = None):
@@ -157,6 +167,8 @@ class PaystackClient(BaseAPIClient):
         self.verification: VerificationClient = VerificationClient(
             secret_key=self._secret_key
         )
+        self.virtual_terminals = VirtualTerminalClient(secret_key=self._secret_key)
+        self.direct_debits = DirectDebitClient(secret_key=self._secret_key)
 
 
 class AsyncPaystackClient(BaseAsyncAPIClient):
@@ -167,51 +179,56 @@ class AsyncPaystackClient(BaseAsyncAPIClient):
 
     Attributes:
         apple_pay: A binding to `AsyncApplePayClient` providing methods for interacting Paystack's Apple Pay API
-            e.g. `PaystackClient.apple_pay.get_domains`.
+            e.g. `AsyncPaystackClient.apple_pay.get_domains`.
         bulk_charges: A binding to `AsyncBulkChargeClient` providing methods for interacting Paystack's Bulk charge API
-            e.g. `PaystackClient.bulk_charges.initiate`.
+            e.g. `AsyncPaystackClient.bulk_charges.initiate`.
         charge: A binding to `AsyncChargeClient` providing methods for interacting Paystack's Charge API
-            e.g. `PaystackClient.charge.charge`.
+            e.g. `AsyncPaystackClient.charge.charge`.
         integration: A binding to `AsyncIntegrationClient` providing methods for interacting Paystack's Integration API
-            e.g. `PaystackClient.integration.get_payment_session_timeout`.
+            e.g. `AsyncPaystackClient.integration.get_payment_session_timeout`.
         customers: A binding to `AsyncCustomerClient` providing methods for interacting Paystack's Customer API
-            e.g. `PaystackClient.customers.create`.
+            e.g. `AsyncPaystackClient.customers.create`.
         dedicated_accounts: A binding to `AsyncDedicatedAccountClient` providing methods for interacting
             Paystack's Dedicated account API e.g. `PaystackClient.dedicated_accounts.create`.
         disputes: A binding to `AsyncDisputeClient` providing methods for interacting Paystack's Dispute API
-            e.g. `PaystackClient.disputes.`.
+            e.g. `AsyncPaystackClient.disputes.`.
         payment_requests: A binding to `AsyncPaymentRequestClient` providing methods for interacting Paystack's Payment
-            request API e.g. `PaystackClient.payment_requests.create`.
+            request API e.g. `AsyncPaystackClient.payment_requests.create`.
         miscellaneous: A binding to `AsyncApplePayClient` providing methods for interacting Paystack's Apple Pay API
-            e.g. `PaystackClient.miscellaneous.get_banks`.
+            e.g. `AsyncPaystackClient.miscellaneous.get_banks`.
         payment_pages: A binding to `AsyncPaymentPageClient` providing methods for interacting Paystack's Payment Page
             API e.g. `PaystackClient.payment_pages.create`.
         plans: A binding to `AsyncPlanClient` providing methods for interacting Paystack's Plan API
-            e.g. `PaystackClient.plans.get_plans`.
+            e.g. `AsyncPaystackClient.plans.get_plans`.
         products: A binding to `AsyncProductClient` providing methods for interacting Paystack's Product API
             e.g. `PaystackClient.products.get_product`.
         refunds: A binding to `AsyncRefundClient` providing methods for interacting Paystack's Refund API
-            e.g. `PaystackClient.refunds.create`.
+            e.g. `AsyncPaystackClient.refunds.create`.
         settlements: A binding to `AsyncSettlementClient` providing methods for interacting Paystack's Settlement API
-            e.g. `PaystackClient.settlements.get_settlements`.
+            e.g. `AsyncPaystackClient.settlements.get_settlements`.
         splits: A binding to `AsyncTransactionSplitClient` providing methods for interacting Paystack's Transaction
-            split API e.g. `PaystackClient.splits.create`.
+            split API e.g. `AsyncPaystackClient.splits.create`.
         subaccounts: A binding to `AsyncSubAccountClient` providing methods for interacting Paystack's subaccount API
-            e.g. `PaystackClient.subaccounts.create`.
+            e.g. `AsyncPaystackClient.subaccounts.create`.
         subscriptions: A binding to `AsyncSubscriptionClient` providing methods for interacting Paystack's Subscription
-            API e.g. `PaystackClient.subscriptions.create`.
+            API e.g. `AsyncPaystackClient.subscriptions.create`.
         terminals: A binding to `AsyncTerminalClient` providing methods for interacting Paystack's Terminal API
-            e.g. `PaystackClient.terminals.send_event`.
+            e.g. `AsyncPaystackClient.terminals.send_event`.
         transactions: A binding to `AsyncTransactionClient` providing methods for interacting Paystack's Transaction
-            API e.g. `PaystackClient.transactions.initiate`.
+            API e.g. `AsyncPaystackClient.transactions.initiate`.
         transfer_recipients: A binding to `AsyncTransferRecipientClient` providing methods for interacting Paystack's
-            Transfer recipients API e.g. `PaystackClient.transfer_recipients.create`.
+            Transfer recipients API e.g. `AsyncPaystackClient.transfer_recipients.create`.
         transfers: A binding to `AsyncTransferClient` providing methods for interacting Paystack's Transfer API
             e.g. `PaystackClient.transfers.finalize`.
         transfer_control: A binding to `AsyncTransferControlClient` providing methods for interacting Paystack's
-            Transfers control API e.g. `PaystackClient.transfer_control.check_balance`.
+            Transfers control API e.g. `AsyncPaystackClient.transfer_control.check_balance`.
         verification: A binding to `AsyncVerificationClient` providing methods for interacting Paystack's Verification
-            API e.g. `PaystackClient.verification.resolve_account_number`.
+            API e.g. `AsyncPaystackClient.verification.resolve_account_number`.
+        virtual_terminals: A binding to `VirtualTerminalClient` providing methods for interacting with Paystack's
+            Virtual Terminal API e.g. `AsyncVirtualTerminalClient.list`.
+        direct_debits: A binding to `AsyncDirectDebitClient` providing methods for interacting with Paystack's
+            Direct Debit API e.g. `AsyncDirectDebitClient.trigger_activation_charge`.
+
     """
 
     def __init__(self, secret_key: str | None = None):
@@ -243,3 +260,5 @@ class AsyncPaystackClient(BaseAsyncAPIClient):
         self.transfers = AsyncTransferClient(secret_key=self._secret_key)
         self.transfer_control = AsyncTransferControlClient(secret_key=self._secret_key)
         self.verification = AsyncVerificationClient(secret_key=self._secret_key)
+        self.virtual_terminals = AsyncVirtualTerminalClient(secret_key=self._secret_key)
+        self.direct_debits = AsyncDirectDebitClient(secret_key=self._secret_key)

{pypaystack2-3.0.2 → pypaystack2-3.2.0}/src/pypaystack2/models/__init__.py

@@ -1,5 +1,6 @@
 # ruff: noqa: F401
 from pypaystack2.models.payload_models import (
+    RefundAccount,
     BulkChargeInstruction,
     LineItem,
     Tax,

{pypaystack2-3.0.2 → pypaystack2-3.2.0}/src/pypaystack2/models/payload_models.py

@@ -5,6 +5,22 @@ from pydantic import BaseModel, model_validator
 from pypaystack2.enums import RecipientType, Currency
 
 
+class RefundAccount(BaseModel):
+    """A dataclass for representing refund account
+    details
+
+    Attributes:
+        currency:The currency of the customer's bank account.
+            It should be the same as the currency the payment was made
+        account_number: The customer's account number
+        bank_id: The ID representing the customer's bank.
+    """
+
+    currency: Currency
+    account_number: str
+    bank_id: str
+
+
 class BulkChargeInstruction(BaseModel):
     """A dataclass for bulk charge instruction.