Changes from gocardless/gocardless-pro-python-template

CHANGELOG.md

@@ -1,4 +1,13 @@
 <!-- @format -->
+# 2.3.0
+
+- Added new endpoint `/balance` that the balances for a creditor
+
+# 2.2.0
+
+- Added `status` filter parameter to Mandate Import Entries.
+- Added `processing_errors` response field to Mandate Import Entry.
+
 # 2.1.0
 
 - Added `mandate_request[consent_type]` parameter to Billing Request creation.

README.rst

@@ -76,6 +76,17 @@ For full documentation, see our `API reference`_.
 Available resources
 ```````````````````
 
+Balances
+''''''''''''''''''''''''''''''''''''''''''
+
+.. code:: python
+
+    # List balances
+    client.balances.list(params={...})
+
+    # Iterate through all balances
+    client.balances.all(params={...})
+
 Bank authorisations
 ''''''''''''''''''''''''''''''''''''''''''
 
@@ -103,6 +114,12 @@ Billing requests
     # Create a Billing Request
     client.billing_requests.create(params={...})
 
+    # [ACH/PAD only] Create a Billing Request with instalments (with dates)
+    client.billing_requests.create_with_instalments_with_dates(params={...})
+
+    # [ACH/PAD only] Create a Billing Request with instalments (with schedule)
+    client.billing_requests.create_with_instalments_with_schedule(params={...})
+
     # Collect customer details
     client.billing_requests.collect_customer_details('BRQ123', params={...})
 

gocardless_pro/__init__.py

@@ -2,5 +2,5 @@
 
 from .client import Client
 
-__version__ = '2.1.0'
+__version__ = '2.3.0'
 

gocardless_pro/api_client.py

@@ -150,7 +150,7 @@ def _default_headers(self):
             'Authorization': 'Bearer {0}'.format(self.access_token),
             'Content-Type': 'application/json',
             'GoCardless-Client-Library': 'gocardless-pro-python',
-            'GoCardless-Client-Version': '2.1.0',
+            'GoCardless-Client-Version': '2.3.0',
             'User-Agent': self._user_agent(),
             'GoCardless-Version': '2015-07-06',
         }
@@ -159,7 +159,7 @@ def _user_agent(self):
         python_version = '.'.join(platform.python_version_tuple()[0:2])
         vm_version = '{}.{}.{}-{}{}'.format(*sys.version_info)
         return ' '.join([
-            'gocardless-pro-python/2.1.0',
+            'gocardless-pro-python/2.3.0',
             'python/{0}'.format(python_version),
             '{0}/{1}'.format(platform.python_implementation(), vm_version),
             '{0}/{1}'.format(platform.system(), platform.release()),

gocardless_pro/client.py

@@ -37,6 +37,10 @@ def __init__(self, access_token=None, environment=None, base_url=None, raise_on_
         self._api_client = ApiClient(base_url, access_token)
         self._raise_on_idempotency_conflict = raise_on_idempotency_conflict
 
+    @property
+    def balances(self):
+        return services.BalancesService(self._api_client, 3, 0.5, self._raise_on_idempotency_conflict)
+
     @property
     def bank_authorisations(self):
         return services.BankAuthorisationsService(self._api_client, 3, 0.5, self._raise_on_idempotency_conflict)

gocardless_pro/resources/__init__.py

@@ -3,6 +3,8 @@
 #   https://github.com/gocardless/crank
 #
 
+from .balance import Balance
+
 from .bank_authorisation import BankAuthorisation
 
 from .bank_details_lookup import BankDetailsLookup

gocardless_pro/resources/balance.py

@@ -0,0 +1,65 @@
+# WARNING: Do not edit by hand, this file was generated by Crank:
+#
+#   https://github.com/gocardless/crank
+#
+
+class Balance(object):
+    """A thin wrapper around a balance, providing easy access to its
+    attributes.
+
+    Example:
+      balance = client.balances.get()
+      balance.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_type(self):
+        return self.attributes.get('balance_type')
+
+
+    @property
+    def currency(self):
+        return self.attributes.get('currency')
+
+
+    @property
+    def last_updated_at(self):
+        return self.attributes.get('last_updated_at')
+
+
+    @property
+    def links(self):
+        return self.Links(self.attributes.get('links'))
+
+
+
+
+
+
+
+
+
+
+
+
+    class Links(object):
+        """Wrapper for the response's 'links' attribute."""
+
+        def __init__(self, attributes):
+            self.attributes = attributes
+
+        @property
+        def creditor(self):
+            return self.attributes.get('creditor')
+
+
+

gocardless_pro/resources/billing_request.py

@@ -116,6 +116,14 @@ def currency(self):
         def instalments(self):
             return self.attributes.get('instalments')
 
+        @property
+        def instalments_with_dates(self):
+            return self.attributes.get('instalments_with_dates')
+
+        @property
+        def instalments_with_schedule(self):
+            return self.attributes.get('instalments_with_schedule')
+
         @property
         def links(self):
             return self.attributes.get('links')
@@ -254,6 +262,10 @@ def payer_requested_dual_signature(self):
         def scheme(self):
             return self.attributes.get('scheme')
 
+        @property
+        def sweeping(self):
+            return self.attributes.get('sweeping')
+
         @property
         def verify(self):
             return self.attributes.get('verify')

gocardless_pro/resources/mandate_import_entry.py

@@ -26,6 +26,11 @@ def links(self):
         return self.Links(self.attributes.get('links'))
 
 
+    @property
+    def processing_errors(self):
+        return self.attributes.get('processing_errors')
+
+
     @property
     def record_identifier(self):
         return self.attributes.get('record_identifier')
@@ -61,3 +66,5 @@ def mandate_import(self):
 
 
 
+
+

gocardless_pro/services/__init__.py

@@ -3,6 +3,7 @@
 #   https://github.com/gocardless/crank
 #
 
+from .balances_service import BalancesService
 from .bank_authorisations_service import BankAuthorisationsService
 from .bank_details_lookups_service import BankDetailsLookupsService
 from .billing_requests_service import BillingRequestsService

gocardless_pro/services/balances_service.py

@@ -0,0 +1,45 @@
+# WARNING: Do not edit by hand, this file was generated by Crank:
+#
+#   https://github.com/gocardless/crank
+#
+
+from . import base_service
+from .. import resources
+from ..paginator import Paginator
+from .. import errors
+
+class BalancesService(base_service.BaseService):
+    """Service class that provides access to the balances
+    endpoints of the GoCardless Pro API.
+    """
+
+    RESOURCE_CLASS = resources.Balance
+    RESOURCE_NAME = 'balances'
+
+
+    def list(self,params=None, headers=None):
+        """List balances.
+
+        Returns a [cursor-paginated](#api-usage-cursor-pagination) list of
+        balances for a given creditor. This endpoint is rate limited to 60
+        requests per minute.
+
+        Args:
+              params (dict, optional): Query string parameters.
+
+        Returns:
+              ListResponse of Balance instances
+        """
+        path = '/balances'
+
+
+        response = self._perform_request('GET', path, params, headers,
+                                         retry_failures=True)
+        return self._resource_for(response)
+
+    def all(self, params=None):
+        if params is None:
+            params = {}
+        return Paginator(self, params)
+
+

gocardless_pro/services/billing_requests_service.py

@@ -21,8 +21,68 @@ def create(self,params=None, headers=None):
         """Create a Billing Request.
 
         <p class="notice"><strong>Important</strong>: All properties associated
-        with `subscription_request` and `instalment_schedule_request` are only
-        supported for ACH and PAD schemes.</p>
+        with `subscription_request` are only supported for ACH and PAD
+        schemes.</p>
+
+        Args:
+              params (dict, optional): Request body.
+
+        Returns:
+              BillingRequest
+        """
+        path = '/billing_requests'
+
+        if params is not None:
+            params = {self._envelope_key(): params}
+
+        try:
+          response = self._perform_request('POST', path, params, headers,
+                                            retry_failures=True)
+        except errors.IdempotentCreationConflictError as err:
+          if self.raise_on_idempotency_conflict:
+            raise err
+          return self.get(identity=err.conflicting_resource_id,
+                          params=params,
+                          headers=headers)
+        return self._resource_for(response)
+
+
+    def create_with_instalments_with_dates(self,params=None, headers=None):
+        """[ACH/PAD only] Create a Billing Request with instalments (with dates).
+
+        <p class="notice"><strong>Important</strong>: All properties associated
+        with `instalment_schedule_request` are only supported for ACH and PAD
+        schemes.</p>
+
+        Args:
+              params (dict, optional): Request body.
+
+        Returns:
+              BillingRequest
+        """
+        path = '/billing_requests'
+
+        if params is not None:
+            params = {self._envelope_key(): params}
+
+        try:
+          response = self._perform_request('POST', path, params, headers,
+                                            retry_failures=True)
+        except errors.IdempotentCreationConflictError as err:
+          if self.raise_on_idempotency_conflict:
+            raise err
+          return self.get(identity=err.conflicting_resource_id,
+                          params=params,
+                          headers=headers)
+        return self._resource_for(response)
+
+
+    def create_with_instalments_with_schedule(self,params=None, headers=None):
+        """[ACH/PAD only] Create a Billing Request with instalments (with schedule).
+
+        <p class="notice"><strong>Important</strong>: All properties associated
+        with `instalment_schedule_request` are only supported for ACH and PAD
+        schemes.</p>
 
         Args:
               params (dict, optional): Request body.

gocardless_pro/services/refunds_service.py

@@ -31,8 +31,8 @@ def create(self,params=None, headers=None):
         is there to prevent two processes from creating refunds without
         awareness of each other.
 
-        - `number_of_refunds_exceeded` if five or more refunds have already
-        been created against the payment.
+        - `number_of_refunds_exceeded` if twenty five or more refunds have
+        already been created against the payment.
 
         - `available_refund_amount_insufficient` if the creditor does not have
         sufficient balance for refunds available to cover the cost of the

gocardless_pro/services/scenario_simulators_service.py

@@ -33,7 +33,7 @@ def run(self,identity,params=None, headers=None):
 <li>`payment_failed`: Transitions a payment through to `failed`. It must start in the `pending_submission` state, and its mandate must be in the `activated` state (unless it is a payment for ACH, BECS, BECS_NZ or SEPA, in which cases the mandate may be `pending_submission`, since their mandates are submitted with their first payment).</li>
 <li>`payment_charged_back`: Behaves the same as the `payout_paid_out` simulator, except that the payment is transitioned to `charged_back` after it is paid out, having been charged back by the customer.</li>
 <li>`payment_chargeback_settled`: Behaves the same as the `payment_charged_back` simulator, except that the charged back payment is additionally included as a debit item in a payout, thereby settling the charged back payment.</li>
-<li>`payment_late_failure`: Transitions a payment through to `late_failure`, having been apparently collected successfully beforehand. It must start in the `pending_submission` state, and its mandate must be in the `activated` state (unless it is a payment for ACH, BECS, BECS_NZ or SEPA, in which cases the mandate may be `pending_submission`, since their mandates are submitted with their first payment). Not compatible with Autogiro mandates.</li>
+<li>`payment_late_failure`: Transitions a payment through to `late_failure`, having been apparently collected successfully beforehand. It must start in either the `pending_submission` or `paid_out` state, and its mandate must be in the `activated` state (unless it is a payment for ACH, BECS, BECS_NZ or SEPA, in which cases the mandate may be `pending_submission`, since their mandates are submitted with their first payment). Not compatible with Autogiro mandates.</li>
 <li>`payment_late_failure_settled`: Behaves the same as the `payment_late_failure` simulator, except that the late failure is additionally included as a debit item in a payout, thereby settling the late failure.</li>
 <li>`payment_submitted`: Transitions a payment to `submitted`, without proceeding any further. It must start in the `pending_submission` state.</li>
 <li>`mandate_activated`: Transitions a mandate through to `activated`, having been submitted to the banks and set up successfully. It must start in the `pending_submission` state. Not compatible with ACH, BECS, BECS_NZ and SEPA mandates, which are submitted and activated with their first payment.</li>

setup.py

@@ -6,7 +6,7 @@
 
 setup(
     name = 'gocardless_pro',
-    version = '2.1.0',
+    version = '2.3.0',
     packages = find_packages(exclude=['tests']),
     install_requires = ['requests>=2.6', 'six'],
     author = 'GoCardless',

tests/client_test.py

@@ -17,6 +17,9 @@ def test_requires_valid_environment():
         Client(access_token=access_token, environment='invalid')
 
 
+def test_balances_returns_service():
+    assert isinstance(client.balances, services.BalancesService)
+
 def test_bank_authorisations_returns_service():
     assert isinstance(client.bank_authorisations, services.BankAuthorisationsService)
 

tests/fixtures/balances.json

@@ -0,0 +1,8 @@
+{ 
+  "list": {
+    "method": "GET",
+    "path_template": "/balances",
+    "url_params": [],
+    "body": {"balances":[{"amount":8081,"balance_type":"confirmed_funds","currency":"EUR","last_updated_at":"2014-01-01T12:00:00.000Z","links":{"creditor":"CR123"}},{"amount":7887,"balance_type":"confirmed_funds","currency":"EUR","last_updated_at":"2014-01-01T12:00:00.000Z","links":{"creditor":"CR123"}}],"meta":{"cursors":{"after":"example after 1847","before":"example before 4059"},"limit":50}}
+  }
+}

tests/fixtures/bank_authorisations.json

@@ -3,12 +3,12 @@
     "method": "POST",
     "path_template": "/bank_authorisations",
     "url_params": [],
-    "body": {"bank_authorisations":{"authorisation_type":"example authorisation_type 8081","authorised_at":"2020-01-01T12:00:00.000Z","created_at":"2024-12-03T12:55:13.866Z","expires_at":"2024-12-03T12:55:13.866Z","id":"BAU123","last_visited_at":"2020-01-01T12:00:00.000Z","links":{"billing_request":"BRQ123","institution":"monzo"},"qr_code_url":"https://pay.gocardless.com/obauth/BAU123/qr_code","redirect_uri":"https://my-website.com/abc/callback","url":"https://pay.gocardless.com/obauth/BAU123"}}
+    "body": {"bank_authorisations":{"authorisation_type":"example authorisation_type 2081","authorised_at":"2020-01-01T12:00:00.000Z","created_at":"2025-03-26T11:54:35.418Z","expires_at":"2025-03-26T11:54:35.418Z","id":"BAU123","last_visited_at":"2020-01-01T12:00:00.000Z","links":{"billing_request":"BRQ123","institution":"monzo"},"qr_code_url":"https://pay.gocardless.com/obauth/BAU123/qr_code","redirect_uri":"https://my-website.com/abc/callback","url":"https://pay.gocardless.com/obauth/BAU123"}}
   },
   "get": {
     "method": "GET",
     "path_template": "/bank_authorisations/:identity",
     "url_params": ["BAU123"],
-    "body": {"bank_authorisations":{"authorisation_type":"example authorisation_type 7887","authorised_at":"2020-01-01T12:00:00.000Z","created_at":"2024-12-03T12:55:13.866Z","expires_at":"2024-12-03T12:55:13.866Z","id":"BAU123","last_visited_at":"2020-01-01T12:00:00.000Z","links":{"billing_request":"BRQ123","institution":"monzo"},"qr_code_url":"https://pay.gocardless.com/obauth/BAU123/qr_code","redirect_uri":"https://my-website.com/abc/callback","url":"https://pay.gocardless.com/obauth/BAU123"}}
+    "body": {"bank_authorisations":{"authorisation_type":"example authorisation_type 1318","authorised_at":"2020-01-01T12:00:00.000Z","created_at":"2025-03-26T11:54:35.418Z","expires_at":"2025-03-26T11:54:35.418Z","id":"BAU123","last_visited_at":"2020-01-01T12:00:00.000Z","links":{"billing_request":"BRQ123","institution":"monzo"},"qr_code_url":"https://pay.gocardless.com/obauth/BAU123/qr_code","redirect_uri":"https://my-website.com/abc/callback","url":"https://pay.gocardless.com/obauth/BAU123"}}
   }
 }