Merge pull request #41 from gocardless/template-changes

Template changes
gocardless · Apr 6, 2020 · b2008ee · b2008ee
2 parents 469adba + a1ee052
commit b2008ee
Show file tree

Hide file tree

Showing 20 changed files with 244 additions and 26 deletions.
diff --git a/README.rst b/README.rst
@@ -388,6 +388,12 @@ Subscriptions
     # Update a subscription
     client.subscriptions.update('SB123', params={...})
 
+    # Pause a subscription
+    client.subscriptions.pause('SB123', params={...})
+
+    # Resume a subscription
+    client.subscriptions.resume('SB123', params={...})
+
     # Cancel a subscription
     client.subscriptions.cancel('SB123', params={...})
 

diff --git a/gocardless_pro/__init__.py b/gocardless_pro/__init__.py
@@ -2,5 +2,5 @@
 
 from .client import Client
 
-__version__ = '1.16.0'
+__version__ = '1.16.1'
 
diff --git a/gocardless_pro/api_client.py b/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.16.0',
+            'GoCardless-Client-Version': '1.16.1',
             '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.16.0',
+            'gocardless-pro-python/1.16.1',
             'python/{0}'.format(python_version),
             '{0}/{1}'.format(platform.python_implementation(), vm_version),
             '{0}/{1}'.format(platform.system(), platform.release()),

diff --git a/gocardless_pro/resources/redirect_flow.py b/gocardless_pro/resources/redirect_flow.py
@@ -41,6 +41,11 @@ def links(self):
         return self.Links(self.attributes.get('links'))
 
 
+    @property
+    def metadata(self):
+        return self.attributes.get('metadata')
+
+
     @property
     def redirect_url(self):
         return self.attributes.get('redirect_url')
@@ -103,3 +108,5 @@ def mandate(self):
 
 
 
+
+
diff --git a/gocardless_pro/resources/subscription.py b/gocardless_pro/resources/subscription.py
@@ -46,6 +46,11 @@ def day_of_month(self):
         return self.attributes.get('day_of_month')
 
 
+    @property
+    def earliest_charge_date_after_resume(self):
+        return self.attributes.get('earliest_charge_date_after_resume')
+
+
     @property
     def end_date(self):
         return self.attributes.get('end_date')
@@ -130,6 +135,8 @@ def upcoming_payments(self):
 
 
 
+
+
 
 
 

diff --git a/gocardless_pro/services/customers_service.py b/gocardless_pro/services/customers_service.py
@@ -130,8 +130,7 @@ def remove(self,identity,params=None, headers=None):
         ID.
         
         <p class="restricted-notice"><strong>The action of removing a customer
-        cannot be
-        reversed, so please use with care.</strong></p>
+        cannot be reversed, so please use with care.</strong></p>
 
         Args:
               identity (string): Unique identifier, beginning with "CU".

diff --git a/gocardless_pro/services/mandates_service.py b/gocardless_pro/services/mandates_service.py
@@ -162,7 +162,7 @@ def reinstate(self,identity,params=None, headers=None):
         This will fail with a `mandate_not_inactive` error if the mandate is
         already being submitted, or is active.
         
-        Mandates can be resubmitted up to 3 times.
+        Mandates can be resubmitted up to 10 times.
 
         Args:
               identity (string): Unique identifier, beginning with "MD". Note that this prefix may not apply to mandates created before 2016.

diff --git a/gocardless_pro/services/subscriptions_service.py b/gocardless_pro/services/subscriptions_service.py
@@ -145,6 +145,92 @@ def update(self,identity,params=None, headers=None):
         return self._resource_for(response)
 
 
+    def pause(self,identity,params=None, headers=None):
+        """Pause a subscription.
+
+        Pause a subscription object.
+        No payments will be created until it is resumed.
+        
+        This can only be used with subscriptions created with `count` or
+        subscriptions without `count` and `end_date`
+        If the subscription has `count` its `end_date` will be `null` after
+        pausing.
+        
+        This fails with:
+        
+        - `forbidden` if the subscription was created by an app and you are not
+        authenticated as that app, or if the subscription was not created by an
+        app and you are authenticated as an app
+        
+        - `validation_failed` if invalid data is provided when attempting to
+        pause a subscription.
+        
+        - `subscription_not_active` if the subscription is no longer active.
+        
+        - `subscription_already_ended` if the subscription has taken all
+        payments.
+        
+
+        Args:
+              identity (string): Unique identifier, beginning with "SB".
+              params (dict, optional): Request body.
+
+        Returns:
+              ListResponse of Subscription instances
+        """
+        path = self._sub_url_params('/subscriptions/:identity/actions/pause', {
+
+            '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)
+
+
+    def resume(self,identity,params=None, headers=None):
+        """Resume a subscription.
+
+        Resume a subscription object.
+        Payments will start to be created again based on the subscriptions
+        recurrence rules.
+        
+        This fails with:
+        
+        - `forbidden` if the subscription was created by an app and you are not
+        authenticated as that app, or if the subscription was not created by an
+        app and you are authenticated as an app
+        
+        - `validation_failed` if invalid data is provided when attempting to
+        resume a subscription.
+        
+        - `subscription_not_paused` if the subscription is not paused.
+        
+        - `subscription_already_scheduled_to_resume` if a subscription already
+        has a scheduled resume date.
+        
+
+        Args:
+              identity (string): Unique identifier, beginning with "SB".
+              params (dict, optional): Request body.
+
+        Returns:
+              ListResponse of Subscription instances
+        """
+        path = self._sub_url_params('/subscriptions/:identity/actions/resume', {
+
+            '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)
+
+
     def cancel(self,identity,params=None, headers=None):
         """Cancel a subscription.
 

diff --git a/setup.py b/setup.py
@@ -6,7 +6,7 @@
 
 setup(
     name = 'gocardless_pro',
-    version = '1.16.0',
+    version = '1.16.1',
     packages = find_packages(exclude=['tests']),
     install_requires = ['requests>=2.6', 'six'],
     author = 'GoCardless',

diff --git a/tests/fixtures/creditors.json b/tests/fixtures/creditors.json
@@ -3,24 +3,24 @@
     "method": "POST",
     "path_template": "/creditors",
     "url_params": [],
-    "body": {"creditors":{"address_line1":"338-346 Goswell Road","address_line2":"Islington","address_line3":"example address_line3 7887","can_create_refunds":false,"city":"London","country_code":"GB","created_at":"2014-01-01T12:00:00.000Z","custom_payment_pages_enabled":true,"fx_payout_currency":"EUR","id":"CR123","links":{"default_aud_payout_account":"BA234","default_cad_payout_account":"BA792","default_dkk_payout_account":"BA790","default_eur_payout_account":"BA456","default_gbp_payout_account":"BA123","default_nzd_payout_account":"BA791","default_sek_payout_account":"BA789","default_usd_payout_account":"BA792"},"logo_url":"https://uploads.gocardless.com/logo.png","mandate_imports_enabled":true,"merchant_responsible_for_notifications":true,"name":"Nude Wines","postal_code":"EC1V 7LQ","region":"example region 8081","scheme_identifiers":[{"address_line1":"221B Baker Street","address_line2":"Marylebone","address_line3":"City of Westminster","can_specify_mandate_reference":false,"city":"London","country_code":"GB","currency":"EUR","email":"[email protected]","minimum_advance_notice":3,"name":"example name 1847","phone_number":"+44 20 1234 1234","postal_code":"NW1 6XE","reference":"example reference 4059","region":"Greater London","scheme":"bacs"}],"verification_status":"action_required"}}
+    "body": {"creditors":{"address_line1":"338-346 Goswell Road","address_line2":"Islington","address_line3":"example address_line3 1847","can_create_refunds":false,"city":"London","country_code":"GB","created_at":"2014-01-01T12:00:00.000Z","custom_payment_pages_enabled":true,"fx_payout_currency":"EUR","id":"CR123","links":{"default_aud_payout_account":"BA234","default_cad_payout_account":"BA792","default_dkk_payout_account":"BA790","default_eur_payout_account":"BA456","default_gbp_payout_account":"BA123","default_nzd_payout_account":"BA791","default_sek_payout_account":"BA789","default_usd_payout_account":"BA792"},"logo_url":"https://uploads.gocardless.com/logo.png","mandate_imports_enabled":true,"merchant_responsible_for_notifications":true,"name":"Nude Wines","postal_code":"EC1V 7LQ","region":"example region 4059","scheme_identifiers":[{"address_line1":"221B Baker Street","address_line2":"Marylebone","address_line3":"City of Westminster","can_specify_mandate_reference":false,"city":"London","country_code":"GB","currency":"EUR","email":"[email protected]","minimum_advance_notice":3,"name":"example name 7887","phone_number":"+44 20 1234 1234","postal_code":"NW1 6XE","reference":"example reference 8081","region":"Greater London","scheme":"bacs"}],"verification_status":"action_required"}}
   },
   "list": {
     "method": "GET",
     "path_template": "/creditors",
     "url_params": [],
-    "body": {"creditors":[{"address_line1":"338-346 Goswell Road","address_line2":"Islington","address_line3":"example address_line3 2081","can_create_refunds":false,"city":"London","country_code":"GB","created_at":"2014-01-01T12:00:00.000Z","custom_payment_pages_enabled":true,"fx_payout_currency":"EUR","id":"CR123","links":{"default_aud_payout_account":"BA234","default_cad_payout_account":"BA792","default_dkk_payout_account":"BA790","default_eur_payout_account":"BA456","default_gbp_payout_account":"BA123","default_nzd_payout_account":"BA791","default_sek_payout_account":"BA789","default_usd_payout_account":"BA792"},"logo_url":"https://uploads.gocardless.com/logo.png","mandate_imports_enabled":true,"merchant_responsible_for_notifications":true,"name":"Nude Wines","postal_code":"EC1V 7LQ","region":"example region 1318","scheme_identifiers":[{"address_line1":"221B Baker Street","address_line2":"Marylebone","address_line3":"City of Westminster","can_specify_mandate_reference":false,"city":"London","country_code":"GB","currency":"EUR","email":"[email protected]","minimum_advance_notice":3,"name":"example name 4425","phone_number":"+44 20 1234 1234","postal_code":"NW1 6XE","reference":"example reference 2540","region":"Greater London","scheme":"bacs"}],"verification_status":"action_required"},{"address_line1":"338-346 Goswell Road","address_line2":"Islington","address_line3":"example address_line3 3300","can_create_refunds":false,"city":"London","country_code":"GB","created_at":"2014-01-01T12:00:00.000Z","custom_payment_pages_enabled":true,"fx_payout_currency":"EUR","id":"CR123","links":{"default_aud_payout_account":"BA234","default_cad_payout_account":"BA792","default_dkk_payout_account":"BA790","default_eur_payout_account":"BA456","default_gbp_payout_account":"BA123","default_nzd_payout_account":"BA791","default_sek_payout_account":"BA789","default_usd_payout_account":"BA792"},"logo_url":"https://uploads.gocardless.com/logo.png","mandate_imports_enabled":true,"merchant_responsible_for_notifications":true,"name":"Nude Wines","postal_code":"EC1V 7LQ","region":"example region 456","scheme_identifiers":[{"address_line1":"221B Baker Street","address_line2":"Marylebone","address_line3":"City of Westminster","can_specify_mandate_reference":false,"city":"London","country_code":"GB","currency":"EUR","email":"[email protected]","minimum_advance_notice":3,"name":"example name 694","phone_number":"+44 20 1234 1234","postal_code":"NW1 6XE","reference":"example reference 8511","region":"Greater London","scheme":"bacs"}],"verification_status":"action_required"}],"meta":{"cursors":{"after":"example after 5089","before":"example before 8162"},"limit":50}}
+    "body": {"creditors":[{"address_line1":"338-346 Goswell Road","address_line2":"Islington","address_line3":"example address_line3 2081","can_create_refunds":false,"city":"London","country_code":"GB","created_at":"2014-01-01T12:00:00.000Z","custom_payment_pages_enabled":true,"fx_payout_currency":"EUR","id":"CR123","links":{"default_aud_payout_account":"BA234","default_cad_payout_account":"BA792","default_dkk_payout_account":"BA790","default_eur_payout_account":"BA456","default_gbp_payout_account":"BA123","default_nzd_payout_account":"BA791","default_sek_payout_account":"BA789","default_usd_payout_account":"BA792"},"logo_url":"https://uploads.gocardless.com/logo.png","mandate_imports_enabled":true,"merchant_responsible_for_notifications":true,"name":"Nude Wines","postal_code":"EC1V 7LQ","region":"example region 2540","scheme_identifiers":[{"address_line1":"221B Baker Street","address_line2":"Marylebone","address_line3":"City of Westminster","can_specify_mandate_reference":false,"city":"London","country_code":"GB","currency":"EUR","email":"[email protected]","minimum_advance_notice":3,"name":"example name 1318","phone_number":"+44 20 1234 1234","postal_code":"NW1 6XE","reference":"example reference 4425","region":"Greater London","scheme":"bacs"}],"verification_status":"action_required"},{"address_line1":"338-346 Goswell Road","address_line2":"Islington","address_line3":"example address_line3 456","can_create_refunds":false,"city":"London","country_code":"GB","created_at":"2014-01-01T12:00:00.000Z","custom_payment_pages_enabled":true,"fx_payout_currency":"EUR","id":"CR123","links":{"default_aud_payout_account":"BA234","default_cad_payout_account":"BA792","default_dkk_payout_account":"BA790","default_eur_payout_account":"BA456","default_gbp_payout_account":"BA123","default_nzd_payout_account":"BA791","default_sek_payout_account":"BA789","default_usd_payout_account":"BA792"},"logo_url":"https://uploads.gocardless.com/logo.png","mandate_imports_enabled":true,"merchant_responsible_for_notifications":true,"name":"Nude Wines","postal_code":"EC1V 7LQ","region":"example region 8511","scheme_identifiers":[{"address_line1":"221B Baker Street","address_line2":"Marylebone","address_line3":"City of Westminster","can_specify_mandate_reference":false,"city":"London","country_code":"GB","currency":"EUR","email":"[email protected]","minimum_advance_notice":3,"name":"example name 694","phone_number":"+44 20 1234 1234","postal_code":"NW1 6XE","reference":"example reference 3300","region":"Greater London","scheme":"bacs"}],"verification_status":"action_required"}],"meta":{"cursors":{"after":"example after 5089","before":"example before 8162"},"limit":50}}
   },
   "get": {
     "method": "GET",
     "path_template": "/creditors/:identity",
     "url_params": ["CR123"],
-    "body": {"creditors":{"address_line1":"338-346 Goswell Road","address_line2":"Islington","address_line3":"example address_line3 1445","can_create_refunds":false,"city":"London","country_code":"GB","created_at":"2014-01-01T12:00:00.000Z","custom_payment_pages_enabled":true,"fx_payout_currency":"EUR","id":"CR123","links":{"default_aud_payout_account":"BA234","default_cad_payout_account":"BA792","default_dkk_payout_account":"BA790","default_eur_payout_account":"BA456","default_gbp_payout_account":"BA123","default_nzd_payout_account":"BA791","default_sek_payout_account":"BA789","default_usd_payout_account":"BA792"},"logo_url":"https://uploads.gocardless.com/logo.png","mandate_imports_enabled":true,"merchant_responsible_for_notifications":true,"name":"Nude Wines","postal_code":"EC1V 7LQ","region":"example region 4728","scheme_identifiers":[{"address_line1":"221B Baker Street","address_line2":"Marylebone","address_line3":"City of Westminster","can_specify_mandate_reference":false,"city":"London","country_code":"GB","currency":"EUR","email":"[email protected]","minimum_advance_notice":3,"name":"example name 1211","phone_number":"+44 20 1234 1234","postal_code":"NW1 6XE","reference":"example reference 3274","region":"Greater London","scheme":"bacs"}],"verification_status":"action_required"}}
+    "body": {"creditors":{"address_line1":"338-346 Goswell Road","address_line2":"Islington","address_line3":"example address_line3 4728","can_create_refunds":false,"city":"London","country_code":"GB","created_at":"2014-01-01T12:00:00.000Z","custom_payment_pages_enabled":true,"fx_payout_currency":"EUR","id":"CR123","links":{"default_aud_payout_account":"BA234","default_cad_payout_account":"BA792","default_dkk_payout_account":"BA790","default_eur_payout_account":"BA456","default_gbp_payout_account":"BA123","default_nzd_payout_account":"BA791","default_sek_payout_account":"BA789","default_usd_payout_account":"BA792"},"logo_url":"https://uploads.gocardless.com/logo.png","mandate_imports_enabled":true,"merchant_responsible_for_notifications":true,"name":"Nude Wines","postal_code":"EC1V 7LQ","region":"example region 3274","scheme_identifiers":[{"address_line1":"221B Baker Street","address_line2":"Marylebone","address_line3":"City of Westminster","can_specify_mandate_reference":false,"city":"London","country_code":"GB","currency":"EUR","email":"[email protected]","minimum_advance_notice":3,"name":"example name 1211","phone_number":"+44 20 1234 1234","postal_code":"NW1 6XE","reference":"example reference 1445","region":"Greater London","scheme":"bacs"}],"verification_status":"action_required"}}
   },
   "update": {
     "method": "PUT",
     "path_template": "/creditors/:identity",
     "url_params": ["CR123"],
-    "body": {"creditors":{"address_line1":"338-346 Goswell Road","address_line2":"Islington","address_line3":"example address_line3 9106","can_create_refunds":false,"city":"London","country_code":"GB","created_at":"2014-01-01T12:00:00.000Z","custom_payment_pages_enabled":true,"fx_payout_currency":"EUR","id":"CR123","links":{"default_aud_payout_account":"BA234","default_cad_payout_account":"BA792","default_dkk_payout_account":"BA790","default_eur_payout_account":"BA456","default_gbp_payout_account":"BA123","default_nzd_payout_account":"BA791","default_sek_payout_account":"BA789","default_usd_payout_account":"BA792"},"logo_url":"https://uploads.gocardless.com/logo.png","mandate_imports_enabled":true,"merchant_responsible_for_notifications":true,"name":"Nude Wines","postal_code":"EC1V 7LQ","region":"example region 3237","scheme_identifiers":[{"address_line1":"221B Baker Street","address_line2":"Marylebone","address_line3":"City of Westminster","can_specify_mandate_reference":false,"city":"London","country_code":"GB","currency":"EUR","email":"[email protected]","minimum_advance_notice":3,"name":"example name 5466","phone_number":"+44 20 1234 1234","postal_code":"NW1 6XE","reference":"example reference 495","region":"Greater London","scheme":"bacs"}],"verification_status":"action_required"}}
+    "body": {"creditors":{"address_line1":"338-346 Goswell Road","address_line2":"Islington","address_line3":"example address_line3 5466","can_create_refunds":false,"city":"London","country_code":"GB","created_at":"2014-01-01T12:00:00.000Z","custom_payment_pages_enabled":true,"fx_payout_currency":"EUR","id":"CR123","links":{"default_aud_payout_account":"BA234","default_cad_payout_account":"BA792","default_dkk_payout_account":"BA790","default_eur_payout_account":"BA456","default_gbp_payout_account":"BA123","default_nzd_payout_account":"BA791","default_sek_payout_account":"BA789","default_usd_payout_account":"BA792"},"logo_url":"https://uploads.gocardless.com/logo.png","mandate_imports_enabled":true,"merchant_responsible_for_notifications":true,"name":"Nude Wines","postal_code":"EC1V 7LQ","region":"example region 495","scheme_identifiers":[{"address_line1":"221B Baker Street","address_line2":"Marylebone","address_line3":"City of Westminster","can_specify_mandate_reference":false,"city":"London","country_code":"GB","currency":"EUR","email":"[email protected]","minimum_advance_notice":3,"name":"example name 9106","phone_number":"+44 20 1234 1234","postal_code":"NW1 6XE","reference":"example reference 3237","region":"Greater London","scheme":"bacs"}],"verification_status":"action_required"}}
   }
 }
Original file line number	Diff line number	Diff line change
Expand Up		@@ -2,5 +2,5 @@

		from .client import Client

		__version__ = '1.16.0'
		__version__ = '1.16.1'