Merge pull request #59 from gocardless/template-changes

Release v1.28.0

CHANGELOG.md

@@ -1,4 +1,8 @@
 <!-- @format -->
+# 1.28.0
+
+- Added support for billing request fallbacks
+
 # 1.27.0
 
 - Release Block API

README.rst

@@ -98,40 +98,43 @@ Billing requests
     # Iterate through all billing_requests
     client.billing_requests.all(params={...})
 
-    # Create a billing_request
+    # Create a Billing Request
     client.billing_requests.create(params={...})
 
-    # Get a single billing request
+    # Get a single Billing Request
     client.billing_requests.get('BRQ123', params={...})
 
-    # Collect customer details for the billing request
+    # Collect customer details for a Billing Request
     client.billing_requests.collect_customer_details('BRQ123', params={...})
 
-    # Collect bank account details for the billing request
+    # Collect bank account details for a Billing Request
     client.billing_requests.collect_bank_account('BRQ123', params={...})
 
-    # Fulfil a billing request
+    # Fulfil a Billing Request
     client.billing_requests.fulfil('BRQ123', params={...})
 
-    # Confirm the customer and bank_account details
+    # Confirm the customer and bank account details
     client.billing_requests.confirm_payer_details('BRQ123', params={...})
 
-    # Cancel a billing request
+    # Cancel a Billing Request
     client.billing_requests.cancel('BRQ123', params={...})
 
-    # Notify the customer of a billing request
+    # Notify the customer of a Billing Request
     client.billing_requests.notify('BRQ123', params={...})
 
+    # Trigger fallback for a Billing Request
+    client.billing_requests.fallback('BRQ123', params={...})
+
 Billing request flows
 ''''''''''''''''''''''''''''''''''''''''''
 
 .. code:: python
 
-    # Create a billing request flow
+    # Create a Billing Request Flow
     client.billing_request_flows.create(params={...})
 
-    # Initialise a billing request flow
-    client.billing_request_flows.initialise('BRQ123', params={...})
+    # Initialise a Billing Request Flow
+    client.billing_request_flows.initialise('BRF123', params={...})
 
 Billing request templates
 ''''''''''''''''''''''''''''''''''''''''''
@@ -329,7 +332,7 @@ Institutions
 
 .. code:: python
 
-    # List institutions
+    # List Institutions
     client.institutions.list(params={...})
 
     # Iterate through all institutions

gocardless_pro/__init__.py

@@ -2,5 +2,5 @@
 
 from .client import Client
 
-__version__ = '1.27.0'
+__version__ = '1.28.0'
 

gocardless_pro/api_client.py

@@ -141,7 +141,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': '1.27.0',
+            'GoCardless-Client-Version': '1.28.0',
             'User-Agent': self._user_agent(),
             'GoCardless-Version': '2015-07-06',
         }
@@ -150,7 +150,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/1.27.0',
+            'gocardless-pro-python/1.28.0',
             'python/{0}'.format(python_version),
             '{0}/{1}'.format(platform.python_implementation(), vm_version),
             '{0}/{1}'.format(platform.system(), platform.release()),

gocardless_pro/resources/billing_request.py

@@ -26,6 +26,11 @@ def created_at(self):
         return self.attributes.get('created_at')
 
 
+    @property
+    def fallback_enabled(self):
+        return self.attributes.get('fallback_enabled')
+
+
     @property
     def id(self):
         return self.attributes.get('id')
@@ -69,6 +74,8 @@ def status(self):
 
 
 
+
+
     class Links(object):
         """Wrapper for the response's 'links' attribute."""
 
@@ -128,6 +135,10 @@ def currency(self):
         def links(self):
             return self.attributes.get('links')
 
+        @property
+        def metadata(self):
+            return self.attributes.get('metadata')
+
         @property
         def scheme(self):
             return self.attributes.get('scheme')
@@ -167,6 +178,10 @@ def description(self):
         def links(self):
             return self.attributes.get('links')
 
+        @property
+        def metadata(self):
+            return self.attributes.get('metadata')
+
         @property
         def scheme(self):
             return self.attributes.get('scheme')

gocardless_pro/resources/billing_request_flow.py

@@ -71,6 +71,11 @@ def session_token(self):
         return self.attributes.get('session_token')
 
 
+    @property
+    def show_redirect_buttons(self):
+        return self.attributes.get('show_redirect_buttons')
+
+
 
 
 
@@ -105,3 +110,5 @@ def billing_request(self):
 
 
 
+
+

gocardless_pro/resources/redirect_flow.py

@@ -87,6 +87,10 @@ class Links(object):
         def __init__(self, attributes):
             self.attributes = attributes
 
+        @property
+        def billing_request(self):
+            return self.attributes.get('billing_request')
+
         @property
         def creditor(self):
             return self.attributes.get('creditor')

gocardless_pro/services/billing_request_flows_service.py

@@ -18,7 +18,7 @@ class BillingRequestFlowsService(base_service.BaseService):
 
 
     def create(self,params=None, headers=None):
-        """Create a billing request flow.
+        """Create a Billing Request Flow.
 
         Creates a new billing request flow.
 
@@ -39,14 +39,14 @@ def create(self,params=None, headers=None):
 
 
     def initialise(self,identity,params=None, headers=None):
-        """Initialise a billing request flow.
+        """Initialise a Billing Request Flow.
 
         Returns the flow having generated a fresh session token which can be
         used to power
         integrations that manipulate the flow.
 
         Args:
-              identity (string): Unique identifier, beginning with "BRQ".
+              identity (string): Unique identifier, beginning with "BRF".
               params (dict, optional): Request body.
 
         Returns:

gocardless_pro/services/billing_requests_service.py

@@ -21,7 +21,7 @@ def list(self,params=None, headers=None):
         """List Billing Requests.
 
         Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your
-        billing_requests.
+        billing requests.
 
         Args:
               params (dict, optional): Query string parameters.
@@ -44,7 +44,7 @@ def all(self, params=None):
 
 
     def create(self,params=None, headers=None):
-        """Create a billing_request.
+        """Create a Billing Request.
 
         
 
@@ -72,7 +72,7 @@ def create(self,params=None, headers=None):
 
 
     def get(self,identity,params=None, headers=None):
-        """Get a single billing request.
+        """Get a single Billing Request.
 
         Fetches a billing request
 
@@ -95,7 +95,7 @@ def get(self,identity,params=None, headers=None):
 
 
     def collect_customer_details(self,identity,params=None, headers=None):
-        """Collect customer details for the billing request.
+        """Collect customer details for a Billing Request.
 
         If the billing request has a pending
         <code>collect_customer_details</code>
@@ -129,7 +129,7 @@ def collect_customer_details(self,identity,params=None, headers=None):
 
 
     def collect_bank_account(self,identity,params=None, headers=None):
-        """Collect bank account details for the billing request.
+        """Collect bank account details for a Billing Request.
 
         If the billing request has a pending
         <code>collect_bank_account</code> action, this endpoint can be
@@ -161,7 +161,7 @@ def collect_bank_account(self,identity,params=None, headers=None):
 
 
     def fulfil(self,identity,params=None, headers=None):
-        """Fulfil a billing request.
+        """Fulfil a Billing Request.
 
         If a billing request is ready to be fulfilled, call this endpoint to
         cause
@@ -187,9 +187,9 @@ def fulfil(self,identity,params=None, headers=None):
 
 
     def confirm_payer_details(self,identity,params=None, headers=None):
-        """Confirm the customer and bank_account details.
+        """Confirm the customer and bank account details.
 
-        This is needed when you have mandate_request. As a scheme compliance
+        This is needed when you have a mandate request. As a scheme compliance
         rule we are required to
         allow the payer to crosscheck the details entered by them and confirm
         it.
@@ -214,7 +214,7 @@ def confirm_payer_details(self,identity,params=None, headers=None):
 
 
     def cancel(self,identity,params=None, headers=None):
-        """Cancel a billing request.
+        """Cancel a Billing Request.
 
         Immediately cancels a billing request, causing all billing request
         flows
@@ -240,7 +240,7 @@ def cancel(self,identity,params=None, headers=None):
 
 
     def notify(self,identity,params=None, headers=None):
-        """Notify the customer of a billing request.
+        """Notify the customer of a Billing Request.
 
         Notifies the customer linked to the billing request, asking them to
         authorise it.
@@ -264,3 +264,28 @@ def notify(self,identity,params=None, headers=None):
                                          retry_failures=False)
         return self._resource_for(response)
 
+
+    def fallback(self,identity,params=None, headers=None):
+        """Trigger fallback for a Billing Request.
+
+        Triggers a fallback from the open-banking flow to direct debit. Note,
+        the billing request must have fallback enabled.
+
+        Args:
+              identity (string): Unique identifier, beginning with "BRQ".
+              params (dict, optional): Request body.
+
+        Returns:
+              BillingRequest
+        """
+        path = self._sub_url_params('/billing_requests/:identity/actions/fallback', {
+
+            'identity': identity,
+          })
+
+        if params is not None:
+            params = {'data': params}
+        response = self._perform_request('POST', path, params, headers,
+                                         retry_failures=False)
+        return self._resource_for(response)
+

gocardless_pro/services/institutions_service.py

@@ -18,9 +18,9 @@ class InstitutionsService(base_service.BaseService):
 
 
     def list(self,params=None, headers=None):
-        """List institutions.
+        """List Institutions.
 
-        Returns a list of all supported institutions.
+        Returns a list of supported institutions.
 
         Args:
               params (dict, optional): Query string parameters.

setup.py

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

tests/fixtures/bank_authorisations.json

@@ -3,12 +3,12 @@
     "method": "GET",
     "path_template": "/bank_authorisations/:identity",
     "url_params": ["BAU123"],
-    "body": {"bank_authorisations":{"authorisation_type":"example authorisation_type 8081","authorised_at":"2020-01-01T12:00:00.000Z","created_at":"2021-12-30T15:25:21.182Z","expires_at":"2021-12-30T15:25:21.182Z","id":"BAU123","last_visited_at":"2020-01-01T12:00:00.000Z","links":{"billing_request":"BRQ123","institution":"monzo"},"redirect_uri":"https://my-website.com/abc/callback","url":"https://pay.gocardless.com/obauth/BAU123"}}
+    "body": {"bank_authorisations":{"authorisation_type":"example authorisation_type 8081","authorised_at":"2020-01-01T12:00:00.000Z","created_at":"2022-04-22T13:38:19.720Z","expires_at":"2022-04-22T13:38:19.720Z","id":"BAU123","last_visited_at":"2020-01-01T12:00:00.000Z","links":{"billing_request":"BRQ123","institution":"monzo"},"redirect_uri":"https://my-website.com/abc/callback","url":"https://pay.gocardless.com/obauth/BAU123"}}
   },
   "create": {
     "method": "POST",
     "path_template": "/bank_authorisations",
     "url_params": [],
-    "body": {"bank_authorisations":{"authorisation_type":"example authorisation_type 7887","authorised_at":"2020-01-01T12:00:00.000Z","created_at":"2021-12-30T15:25:21.182Z","expires_at":"2021-12-30T15:25:21.182Z","id":"BAU123","last_visited_at":"2020-01-01T12:00:00.000Z","links":{"billing_request":"BRQ123","institution":"monzo"},"redirect_uri":"https://my-website.com/abc/callback","url":"https://pay.gocardless.com/obauth/BAU123"}}
+    "body": {"bank_authorisations":{"authorisation_type":"example authorisation_type 7887","authorised_at":"2020-01-01T12:00:00.000Z","created_at":"2022-04-22T13:38:19.720Z","expires_at":"2022-04-22T13:38:19.720Z","id":"BAU123","last_visited_at":"2020-01-01T12:00:00.000Z","links":{"billing_request":"BRQ123","institution":"monzo"},"redirect_uri":"https://my-website.com/abc/callback","url":"https://pay.gocardless.com/obauth/BAU123"}}
   }
 }

tests/fixtures/billing_request_flows.json

@@ -3,12 +3,12 @@
     "method": "POST",
     "path_template": "/billing_request_flows",
     "url_params": [],
-    "body": {"billing_request_flows":{"authorisation_url":"https://monzo.com/abc-123-things","auto_fulfil":true,"created_at":"2021-12-30T15:25:21.185Z","exit_uri":"https://my-website.com/abc/callback","expires_at":"2021-12-30T15:25:21.185Z","id":"BRF123","links":{"billing_request":"BRQ123"},"lock_bank_account":true,"lock_customer_details":true,"redirect_uri":"https://my-website.com/abc/callback","session_token":"sesh_123"}}
+    "body": {"billing_request_flows":{"authorisation_url":"https://monzo.com/abc-123-things","auto_fulfil":false,"created_at":"2022-04-22T13:38:19.722Z","exit_uri":"https://my-website.com/abc/callback","expires_at":"2022-04-22T13:38:19.722Z","id":"BRF123","links":{"billing_request":"BRQ123"},"lock_bank_account":true,"lock_customer_details":true,"redirect_uri":"https://my-website.com/abc/callback","session_token":"sesh_123","show_redirect_buttons":false}}
   },
   "initialise": {
     "method": "POST",
     "path_template": "/billing_request_flows/:identity/actions/initialise",
-    "url_params": ["BRQ123"],
-    "body": {"billing_request_flows":{"authorisation_url":"https://monzo.com/abc-123-things","auto_fulfil":true,"created_at":"2021-12-30T15:25:21.185Z","exit_uri":"https://my-website.com/abc/callback","expires_at":"2021-12-30T15:25:21.185Z","id":"BRF123","links":{"billing_request":"BRQ123"},"lock_bank_account":false,"lock_customer_details":true,"redirect_uri":"https://my-website.com/abc/callback","session_token":"sesh_123"}}
+    "url_params": ["BRF123"],
+    "body": {"billing_request_flows":{"authorisation_url":"https://monzo.com/abc-123-things","auto_fulfil":true,"created_at":"2022-04-22T13:38:19.722Z","exit_uri":"https://my-website.com/abc/callback","expires_at":"2022-04-22T13:38:19.722Z","id":"BRF123","links":{"billing_request":"BRQ123"},"lock_bank_account":false,"lock_customer_details":true,"redirect_uri":"https://my-website.com/abc/callback","session_token":"sesh_123","show_redirect_buttons":false}}
   }
 }