Upgrade SDK to support Payload API V2

README.md

@@ -4,7 +4,7 @@ A Python library for integrating [Payload](https://payload.com).
 
 ## Installation
 
-## Install using pip
+### Install using pip
 
 ```bash
 pip install payload-api
@@ -39,6 +39,27 @@ import payload
 pl = payload.Session('secret_key_3bW9JMZtPVDOfFNzwRdfE')
 ```
 
+### API Versioning
+
+The Payload API supports multiple versions. You can specify which version to use when making requests:
+
+```python
+import payload as pl
+pl.api_key = 'secret_key_3bW9JMZtPVDOfFNzwRdfE'
+pl.api_version = 'v2'  # Use API v2
+```
+
+Or with sessions:
+
+```python
+import payload
+pl = payload.Session(
+    'secret_key_3bW9JMZtPVDOfFNzwRdfE',
+    api_version='v2'
+)
+```
+
+API v2 introduces new objects including `Profile`, `Intent`, `Entity`, `Transfer`, `ProcessingAgreement`, and more. See the [Payload API Documentation](https://docs.payload.com) for details on API versions.
 
 ### Creating an Object
 
@@ -60,7 +81,9 @@ customer = pl.Customer.create(
 payment = pl.Payment.create(
     amount=100.0,
     payment_method=pl.Card(
-        card_number='4242 4242 4242 4242'
+        card_number='4242 4242 4242 4242',
+        expiry='12/28',
+        card_code='123'
     )
 )
 ```
@@ -107,12 +130,21 @@ payments = pl.Payment.filter_by(
 
 ### Testing the Payload Python Library
 
-Tests are contained within the tests/ directory. To run a test file, once within the
-pipenv shell, enter the command in terminal
+Tests are contained within the tests/ directory. To run tests:
 
 ```bash
-TEST_SECRET_KEY=test_api_key pytest tests/{__FILENAME__}.py
- ```
+# Install dependencies
+pdm install
+
+# Run integration tests
+TEST_SECRET_KEY=test_api_key pdm run pytest tests/int/
+
+# Run unit tests
+pdm run pytest tests/unit/
+
+# Run a specific test file
+TEST_SECRET_KEY=test_api_key pdm run pytest tests/int/test_transaction.py
+```
 
 
 ## Documentation

payload/__init__.py

@@ -4,20 +4,151 @@
 
 Documentation: https://docs.payload.com
 
-:copyright: (c) 2021 Payload (http://payload.com)
+:copyright: (c) 2026 Payload (http://payload.com)
 :license: MIT License
 """
 
-from .version import __version__
-from .exceptions import *
-from .objects import *
-from .arm import Attr as attr, ARMRequest, session_factory
+__all__ = [
+    # Version
+    '__version__',
+    # ARM
+    'ARMRequest',
+    'attr',
+    'session_factory',
+    'Session',
+    # Functions
+    'create',
+    'update',
+    'delete',
+    # Module variables
+    'URL',
+    'api_key',
+    'api_url',
+    'api_version',
+    # Submodules
+    'objects',
+    # Exceptions
+    'BadRequest',
+    'Forbidden',
+    'InternalServerError',
+    'InvalidAttributes',
+    'NotFound',
+    'PayloadError',
+    'ServiceUnavailable',
+    'TooManyRequests',
+    'TransactionDeclined',
+    'Unauthorized',
+    'UnknownResponse',
+    # Objects
+    'AccessToken',
+    'Account',
+    'BankAccount',
+    'BillingCharge',
+    'BillingSchedule',
+    'Card',
+    'ChargeItem',
+    'ClientToken',
+    'Credit',
+    'Customer',
+    'Deposit',
+    'Invoice',
+    'Ledger',
+    'LineItem',
+    'OAuthToken',
+    'Org',
+    'Payment',
+    'PaymentActivation',
+    'PaymentItem',
+    'PaymentLink',
+    'PaymentMethod',
+    'ProcessingAccount',
+    'ProcessingRule',
+    'Refund',
+    'Transaction',
+    'User',
+    'Webhook',
+    # New API v2 Objects
+    'Profile',
+    'BillingItem',
+    'Intent',
+    'InvoiceItem',
+    'PaymentAllocation',
+    'Entity',
+    'Stakeholder',
+    'ProcessingAgreement',
+    'Transfer',
+    'TransactionOperation',
+    'CheckFront',
+    'CheckBack',
+    'ProcessingSettings',
+]
+
 from . import objects
+from .arm import ARMRequest
+from .arm import Attr as attr
+from .arm import session_factory
+from .exceptions import (
+    BadRequest,
+    Forbidden,
+    InternalServerError,
+    InvalidAttributes,
+    NotFound,
+    PayloadError,
+    ServiceUnavailable,
+    TooManyRequests,
+    TransactionDeclined,
+    Unauthorized,
+    UnknownResponse,
+)
+from .objects import (  # API v2 Objects
+    AccessToken,
+    Account,
+    BankAccount,
+    BillingCharge,
+    BillingItem,
+    BillingSchedule,
+    Card,
+    ChargeItem,
+    CheckBack,
+    CheckFront,
+    ClientToken,
+    Credit,
+    Customer,
+    Deposit,
+    Entity,
+    Intent,
+    Invoice,
+    InvoiceItem,
+    Ledger,
+    LineItem,
+    OAuthToken,
+    Org,
+    Payment,
+    PaymentActivation,
+    PaymentAllocation,
+    PaymentItem,
+    PaymentLink,
+    PaymentMethod,
+    ProcessingAccount,
+    ProcessingAgreement,
+    ProcessingRule,
+    ProcessingSettings,
+    Profile,
+    Refund,
+    Stakeholder,
+    Transaction,
+    TransactionOperation,
+    Transfer,
+    User,
+    Webhook,
+)
+from .version import __version__
 
 URL = 'https://api.payload.com'
 
 api_key = None
 api_url = URL
+api_version = None
 
 Session = session_factory('PayloadSession', objects)
 

payload/arm/request.py

@@ -31,6 +31,9 @@ def _request(self, method, id=None, headers=None, params=None, json=None):
         auth = (session.api_key, '')
         files = {}
 
+        if session.api_version:
+            headers['X-API-Version'] = session.api_version
+
         if json:
             flat_data = nested_qstring_keys(copy.copy(json))
             for k in list(flat_data):
@@ -63,6 +66,7 @@ def _request(self, method, id=None, headers=None, params=None, json=None):
                 auth=auth,
                 data=flat_data,
                 files=files,
+                headers=headers,
             )
         else:
             response = getattr(requests, method)(

payload/arm/session.py

@@ -1,22 +1,24 @@
-from .request import ARMRequest
-from .object import ARMObject, ARMObjectWrapper
-from . import Attr
-import types
-import inspect
 import payload
 
+from . import Attr
+from .object import ARMObjectWrapper
+from .request import ARMRequest
+
+
 def get_object(objects, name):
     if isinstance(objects, dict):
         return objects[name]
     else:
         return getattr(objects, name)
 
+
 class Session(object):
     attr = Attr
 
-    def __init__(self, api_key=None, api_url=None):
+    def __init__(self, api_key=None, api_url=None, api_version=None):
         self.api_key = api_key or payload.api_key
         self.api_url = api_url or payload.api_url
+        self.api_version = api_version or payload.api_version
 
     def create(self, *args, **kwargs):
         return ARMRequest(session=self).create(*args, **kwargs)
@@ -30,5 +32,6 @@ def delete(self, *args, **kwargs):
     def __getattr__(self, name):
         return ARMObjectWrapper(get_object(self._objects, name), self)
 
+
 def session_factory(name, objects):
     return type(name, (Session,), {'_objects': objects})