Changes from gocardless/gocardless-pro-python-template

README.rst

@@ -8,7 +8,7 @@ A Python client for interacting with the GoCardless Pro API.
 
 |pypi-badge|
 
-Tested against Python 3.8, 3.9, 3.10, 3.11 and 3.12.
+Tested against Python 3.9, 3.10, 3.11 and 3.12.
 
 - `"Getting Started" guide <https://developer.gocardless.com/getting-started/api/introduction/?lang=python>`_ with copy and paste Python code samples
 - `API reference`_
@@ -187,7 +187,7 @@ Billing request templates
     client.billing_request_templates.create(params={...})
 
     # Update a Billing Request Template
-    client.billing_request_templates.update('BRQ123', params={...})
+    client.billing_request_templates.update('BRT123', params={...})
 
 Billing request with actions
 ''''''''''''''''''''''''''''''''''''''''''
@@ -439,13 +439,13 @@ Mandate imports
     client.mandate_imports.create(params={...})
 
     # Get a mandate import
-    client.mandate_imports.get('IM000010790WX1', params={...})
+    client.mandate_imports.get('IM123', params={...})
 
     # Submit a mandate import
-    client.mandate_imports.submit('IM000010790WX1', params={...})
+    client.mandate_imports.submit('IM123', params={...})
 
     # Cancel a mandate import
-    client.mandate_imports.cancel('IM000010790WX1', params={...})
+    client.mandate_imports.cancel('IM123', params={...})
 
 Mandate import entries
 ''''''''''''''''''''''''''''''''''''''''''
@@ -492,13 +492,13 @@ Outbound payments
     client.outbound_payments.withdraw(params={...})
 
     # Cancel an outbound payment
-    client.outbound_payments.cancel('OUT01JR7P5PKW3K7Q34CJAWC03E82', params={...})
+    client.outbound_payments.cancel('OUT123', params={...})
 
     # Approve an outbound payment
-    client.outbound_payments.approve('OUT01JR7P5PKW3K7Q34CJAWC03E82', params={...})
+    client.outbound_payments.approve('OUT123', params={...})
 
     # Get an outbound payment
-    client.outbound_payments.get('OUT01JR7P5PKW3K7Q34CJAWC03E82', params={...})
+    client.outbound_payments.get('OUT123', params={...})
 
     # List outbound payments
     client.outbound_payments.list(params={...})
@@ -507,7 +507,7 @@ Outbound payments
     client.outbound_payments.all(params={...})
 
     # Update an outbound payment
-    client.outbound_payments.update('OUT01JR7P5PKW3K7Q34CJAWC03E82', params={...})
+    client.outbound_payments.update('OUT123', params={...})
 
 Payer authorisations
 ''''''''''''''''''''''''''''''''''''''''''
@@ -563,6 +563,17 @@ Payments
     # Retry a payment
     client.payments.retry('PM123', params={...})
 
+Payment account transactions
+''''''''''''''''''''''''''''''''''''''''''
+
+.. code:: python
+
+    # List payment account transactions
+    client.payment_account_transactions.list('BA123', params={...})
+
+    # Iterate through all payment_account_transactions
+    client.payment_account_transactions.all(params={...})
+
 Payouts
 ''''''''''''''''''''''''''''''''''''''''''
 

gocardless_pro/client.py

@@ -153,6 +153,10 @@ def payer_themes(self):
     def payments(self):
         return services.PaymentsService(self._api_client, 3, 0.5, self._raise_on_idempotency_conflict)
 
+    @property
+    def payment_account_transactions(self):
+        return services.PaymentAccountTransactionsService(self._api_client, 3, 0.5, self._raise_on_idempotency_conflict)
+
     @property
     def payouts(self):
         return services.PayoutsService(self._api_client, 3, 0.5, self._raise_on_idempotency_conflict)

gocardless_pro/paginator.py

@@ -8,9 +8,10 @@ class Paginator(object):
     loading each page until the last.
     """
 
-    def __init__(self, service, params):
+    def __init__(self, service, params, identity_params=None):
         self._service = service
         self._params = params
+        self._identity_params = identity_params or {}
 
     def __iter__(self):
         return self._iterate()
@@ -30,5 +31,5 @@ def _fetch_page(self, after):
         params = self._params.copy()
         if after is not None:
             params.update({'after': after})
-        return self._service.list(params=params)
+        return self._service.list(**self._identity_params, params=params)
 

gocardless_pro/resources/__init__.py

@@ -61,6 +61,8 @@
 
 from .payment import Payment
 
+from .payment_account_transaction import PaymentAccountTransaction
+
 from .payout import Payout
 
 from .payout_item import PayoutItem

gocardless_pro/resources/billing_request.py

@@ -242,6 +242,10 @@ def currency(self):
         def description(self):
             return self.attributes.get('description')
 
+        @property
+        def funds_settlement(self):
+            return self.attributes.get('funds_settlement')
+
         @property
         def links(self):
             return self.attributes.get('links')

gocardless_pro/resources/event.py

@@ -61,6 +61,11 @@ def resource_type(self):
         return self.attributes.get('resource_type')
 
 
+    @property
+    def source(self):
+        return self.Source(self.attributes.get('source'))
+
+
 
 
 
@@ -162,6 +167,10 @@ def instalment_schedule(self):
         def mandate(self):
             return self.attributes.get('mandate')
 
+        @property
+        def mandate_request(self):
+            return self.attributes.get('mandate_request')
+
         @property
         def mandate_request_mandate(self):
             return self.attributes.get('mandate_request_mandate')
@@ -222,3 +231,20 @@ def subscription(self):
 
 
 
+
+    class Source(object):
+        """Wrapper for the response's 'source' attribute."""
+
+        def __init__(self, attributes):
+            self.attributes = attributes
+
+        @property
+        def name(self):
+            return self.attributes.get('name')
+
+        @property
+        def type(self):
+            return self.attributes.get('type')
+
+
+

gocardless_pro/resources/mandate.py

@@ -110,8 +110,16 @@ def max_amount_per_payment(self):
             return self.attributes.get('max_amount_per_payment')
 
         @property
-        def periods(self):
-            return self.attributes.get('periods')
+        def max_amount_per_period(self):
+            return self.attributes.get('max_amount_per_period')
+
+        @property
+        def max_payments_per_period(self):
+            return self.attributes.get('max_payments_per_period')
+
+        @property
+        def period(self):
+            return self.attributes.get('period')
 
         @property
         def start_date(self):

gocardless_pro/resources/payment.py

@@ -81,6 +81,11 @@ def retry_if_possible(self):
         return self.attributes.get('retry_if_possible')
 
 
+    @property
+    def scheme(self):
+        return self.attributes.get('scheme')
+
+
     @property
     def status(self):
         return self.attributes.get('status')
@@ -165,3 +170,5 @@ def subscription(self):
 
 
 
+
+

gocardless_pro/resources/payment_account_transaction.py

@@ -0,0 +1,108 @@
+# WARNING: Do not edit by hand, this file was generated by Crank:
+#
+#   https://github.com/gocardless/crank
+#
+
+class PaymentAccountTransaction(object):
+    """A thin wrapper around a payment_account_transaction, providing easy access to its
+    attributes.
+
+    Example:
+      payment_account_transaction = client.payment_account_transactions.get()
+      payment_account_transaction.id
+    """
+
+    def __init__(self, attributes, api_response):
+        self.attributes = attributes
+        self.api_response = api_response
+
+    @property
+    def amount(self):
+        return self.attributes.get('amount')
+
+
+    @property
+    def balance_after_transaction(self):
+        return self.attributes.get('balance_after_transaction')
+
+
+    @property
+    def counterparty_name(self):
+        return self.attributes.get('counterparty_name')
+
+
+    @property
+    def currency(self):
+        return self.attributes.get('currency')
+
+
+    @property
+    def description(self):
+        return self.attributes.get('description')
+
+
+    @property
+    def direction(self):
+        return self.attributes.get('direction')
+
+
+    @property
+    def id(self):
+        return self.attributes.get('id')
+
+
+    @property
+    def links(self):
+        return self.Links(self.attributes.get('links'))
+
+
+    @property
+    def reference(self):
+        return self.attributes.get('reference')
+
+
+    @property
+    def value_date(self):
+        return self.attributes.get('value_date')
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+    class Links(object):
+        """Wrapper for the response's 'links' attribute."""
+
+        def __init__(self, attributes):
+            self.attributes = attributes
+
+        @property
+        def outbound_payment(self):
+            return self.attributes.get('outbound_payment')
+
+        @property
+        def payment_bank_account(self):
+            return self.attributes.get('payment_bank_account')
+
+        @property
+        def payout(self):
+            return self.attributes.get('payout')
+
+
+
+
+
+
+

gocardless_pro/services/__init__.py

@@ -32,6 +32,7 @@
 from .payer_authorisations_service import PayerAuthorisationsService
 from .payer_themes_service import PayerThemesService
 from .payments_service import PaymentsService
+from .payment_account_transactions_service import PaymentAccountTransactionsService
 from .payouts_service import PayoutsService
 from .payout_items_service import PayoutItemsService
 from .redirect_flows_service import RedirectFlowsService

gocardless_pro/services/balances_service.py

@@ -37,9 +37,10 @@ def list(self,params=None, headers=None):
                                          retry_failures=True)
         return self._resource_for(response)
 
-    def all(self, params=None):
+    def all(self,params=None):
         if params is None:
             params = {}
-        return Paginator(self, params)
+        return Paginator(self, params, identity_params={
+          })
 
 

gocardless_pro/services/bank_account_details_service.py

@@ -21,7 +21,12 @@ def get(self,identity,params=None, headers=None):
         """Get encrypted bank details.
 
         Returns bank account details in the flattened JSON Web Encryption
-        format described in RFC 7516
+        format described in RFC 7516.
+
+        You must specify a `Gc-Key-Id` header when using this endpoint. See
+        [Public Key
+        Setup](https://developer.gocardless.com/gc-embed/bank-details-access#public_key_setup)
+        for more details.
 
         Args:
               identity (string): Unique identifier, beginning with "BA".

gocardless_pro/services/billing_request_templates_service.py

@@ -36,10 +36,11 @@ def list(self,params=None, headers=None):
                                          retry_failures=True)
         return self._resource_for(response)
 
-    def all(self, params=None):
+    def all(self,params=None):
         if params is None:
             params = {}
-        return Paginator(self, params)
+        return Paginator(self, params, identity_params={
+          })
 
 
 
@@ -101,7 +102,7 @@ def update(self,identity,params=None, headers=None):
         Billing Requests created by this template.
 
         Args:
-              identity (string): Unique identifier, beginning with "BRQ".
+              identity (string): Unique identifier, beginning with "BRT".
               params (dict, optional): Request body.
 
         Returns:

gocardless_pro/services/billing_requests_service.py

@@ -230,10 +230,11 @@ def list(self,params=None, headers=None):
                                          retry_failures=True)
         return self._resource_for(response)
 
-    def all(self, params=None):
+    def all(self,params=None):
         if params is None:
             params = {}
-        return Paginator(self, params)
+        return Paginator(self, params, identity_params={
+          })