Merge pull request #111 from gocardless/template-changes

Changes from gocardless/gocardless-pro-python-template

Author: ashwinm91

README.rst

@@ -189,6 +189,14 @@ Billing request templates
     # Update a Billing Request Template
     client.billing_request_templates.update('BRQ123', params={...})
 
+Billing request with actions
+''''''''''''''''''''''''''''''''''''''''''
+
+.. code:: python
+
+    # Create a Billing Request with Actions
+    client.billing_request_with_actions.create_with_actions(params={...})
+
 Blocks
 ''''''''''''''''''''''''''''''''''''''''''
 

gocardless_pro/__init__.py

@@ -2,5 +2,5 @@
 
 from .client import Client
 
-__version__ = '2.7.0'
+__version__ = '2.8.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.7.0',
+            'GoCardless-Client-Version': '2.8.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.7.0',
+            'gocardless-pro-python/2.8.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

@@ -65,6 +65,10 @@ def billing_request_flows(self):
     def billing_request_templates(self):
         return services.BillingRequestTemplatesService(self._api_client, 3, 0.5, self._raise_on_idempotency_conflict)
 
+    @property
+    def billing_request_with_actions(self):
+        return services.BillingRequestWithActionsService(self._api_client, 3, 0.5, self._raise_on_idempotency_conflict)
+
     @property
     def blocks(self):
         return services.BlocksService(self._api_client, 3, 0.5, self._raise_on_idempotency_conflict)

gocardless_pro/resources/__init__.py

@@ -17,6 +17,8 @@
 
 from .billing_request_template import BillingRequestTemplate
 
+from .billing_request_with_action import BillingRequestWithAction
+
 from .block import Block
 
 from .creditor import Creditor

gocardless_pro/resources/billing_request_with_action.py

@@ -0,0 +1,143 @@
+# WARNING: Do not edit by hand, this file was generated by Crank:
+#
+#   https://github.com/gocardless/crank
+#
+
+class BillingRequestWithAction(object):
+    """A thin wrapper around a billing_request_with_action, providing easy access to its
+    attributes.
+
+    Example:
+      billing_request_with_action = client.billing_request_with_actions.get()
+      billing_request_with_action.id
+    """
+
+    def __init__(self, attributes, api_response):
+        self.attributes = attributes
+        self.api_response = api_response
+
+    @property
+    def bank_authorisations(self):
+        return self.BankAuthorisations(self.attributes.get('bank_authorisations'))
+  
+
+    @property
+    def billing_requests(self):
+        return self.BillingRequests(self.attributes.get('billing_requests'))
+  
+
+
+  
+    class BankAuthorisations(object):
+        """Wrapper for the response's 'bank_authorisations' attribute."""
+
+        def __init__(self, attributes):
+            self.attributes = attributes
+    
+        @property
+        def authorisation_type(self):
+            return self.attributes.get('authorisation_type')
+    
+        @property
+        def authorised_at(self):
+            return self.attributes.get('authorised_at')
+    
+        @property
+        def created_at(self):
+            return self.attributes.get('created_at')
+    
+        @property
+        def expires_at(self):
+            return self.attributes.get('expires_at')
+    
+        @property
+        def id(self):
+            return self.attributes.get('id')
+    
+        @property
+        def last_visited_at(self):
+            return self.attributes.get('last_visited_at')
+    
+        @property
+        def links(self):
+            return self.attributes.get('links')
+    
+        @property
+        def qr_code_url(self):
+            return self.attributes.get('qr_code_url')
+    
+        @property
+        def redirect_uri(self):
+            return self.attributes.get('redirect_uri')
+    
+        @property
+        def url(self):
+            return self.attributes.get('url')
+    
+  
+
+  
+    class BillingRequests(object):
+        """Wrapper for the response's 'billing_requests' attribute."""
+
+        def __init__(self, attributes):
+            self.attributes = attributes
+    
+        @property
+        def actions(self):
+            return self.attributes.get('actions')
+    
+        @property
+        def created_at(self):
+            return self.attributes.get('created_at')
+    
+        @property
+        def fallback_enabled(self):
+            return self.attributes.get('fallback_enabled')
+    
+        @property
+        def fallback_occurred(self):
+            return self.attributes.get('fallback_occurred')
+    
+        @property
+        def id(self):
+            return self.attributes.get('id')
+    
+        @property
+        def instalment_schedule_request(self):
+            return self.attributes.get('instalment_schedule_request')
+    
+        @property
+        def links(self):
+            return self.attributes.get('links')
+    
+        @property
+        def mandate_request(self):
+            return self.attributes.get('mandate_request')
+    
+        @property
+        def metadata(self):
+            return self.attributes.get('metadata')
+    
+        @property
+        def payment_request(self):
+            return self.attributes.get('payment_request')
+    
+        @property
+        def purpose_code(self):
+            return self.attributes.get('purpose_code')
+    
+        @property
+        def resources(self):
+            return self.attributes.get('resources')
+    
+        @property
+        def status(self):
+            return self.attributes.get('status')
+    
+        @property
+        def subscription_request(self):
+            return self.attributes.get('subscription_request')
+    
+  
+

gocardless_pro/resources/outbound_payment.py

@@ -26,6 +26,11 @@ def created_at(self):
         return self.attributes.get('created_at')
 
 
+    @property
+    def currency(self):
+        return self.attributes.get('currency')
+  
+
     @property
     def description(self):
         return self.attributes.get('description')
@@ -90,6 +95,8 @@ def verifications(self):
 
 
 
+
+  
     class Links(object):
         """Wrapper for the response's 'links' attribute."""
 

gocardless_pro/services/__init__.py

@@ -10,6 +10,7 @@
 from .billing_requests_service import BillingRequestsService
 from .billing_request_flows_service import BillingRequestFlowsService
 from .billing_request_templates_service import BillingRequestTemplatesService
+from .billing_request_with_actions_service import BillingRequestWithActionsService
 from .blocks_service import BlocksService
 from .creditors_service import CreditorsService
 from .creditor_bank_accounts_service import CreditorBankAccountsService

gocardless_pro/services/billing_request_with_actions_service.py

@@ -0,0 +1,44 @@
+# 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 BillingRequestWithActionsService(base_service.BaseService):
+    """Service class that provides access to the billing_request_with_actions
+    endpoints of the GoCardless Pro API.
+    """
+
+    RESOURCE_CLASS = resources.BillingRequestWithAction
+    RESOURCE_NAME = 'billing_request_with_actions'
+
+
+    def create_with_actions(self,params=None, headers=None):
+        """Create a Billing Request with Actions.
+
+        Creates a billing request and completes any specified actions in a
+        single request.
+        This endpoint allows you to create a billing request and immediately
+        complete actions
+        such as collecting customer details, bank account details, or other
+        required actions.
+
+        Args:
+              params (dict, optional): Request body.
+
+        Returns:
+              BillingRequestWithAction
+        """
+        path = '/billing_requests/create_with_actions'
+        
+        if params is not None:
+            params = {self._envelope_key(): params}
+
+        response = self._perform_request('POST', path, params, headers,
+                                         retry_failures=True)
+        return self._resource_for(response)
+  

gocardless_pro/services/refunds_service.py

@@ -31,9 +31,6 @@ 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 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
         requested refund.