Changes from gocardless/client-library-templates

gocardless_pro/services/balances_service.py

@@ -21,7 +21,7 @@ def list(self,params=None, headers=None):
         """List balances.
 
         Returns a cursor-paginated
-        (https://developer.gocardless.com/api-reference/#api-usage-cursor-pagination)
+        (https://docs.gocardless.com/docs/api-reference/data-conventions#cursor-pagination)
         list of balances for a given creditor. This endpoint is rate limited to
         60 requests per minute.
 

gocardless_pro/services/bank_account_details_service.py

@@ -25,7 +25,7 @@ def get(self,identity,params=None, headers=None):
 
         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)
+        (https://docs.gocardless.com/docs/gc-embed/bank-details-access#public-key-setup)
         for more details.
 
         Args:

gocardless_pro/services/bank_details_lookups_service.py

@@ -35,17 +35,17 @@ def create(self,params=None, headers=None):
         "Account holder name does not match bank account details provided".
 
         If your request returns an error
-        (https://developer.gocardless.com/api-reference/#api-usage-errors) or
-        the `available_debit_schemes`
+        (https://docs.gocardless.com/docs/api-reference/responses-and-errors)
+        or the `available_debit_schemes`
         attribute is an empty array, you will not be able to collect payments
         from the
         specified bank account. GoCardless may be able to collect payments from
         an account
         even if no `bic` is returned.
 
         Bank account details may be supplied using local details
-        (https://developer.gocardless.com/api-reference/#appendix-local-bank-details)
-        or an IBAN.
+        (https://docs.gocardless.com/docs/api-reference/local-bank-details) or
+        an IBAN.
 
         ACH scheme For compliance reasons, an extra validation step is done
         using

gocardless_pro/services/billing_request_templates_service.py

@@ -21,7 +21,7 @@ def list(self,params=None, headers=None):
         """List Billing Request Templates.
 
         Returns a cursor-paginated
-        (https://developer.gocardless.com/api-reference/#api-usage-cursor-pagination)
+        (https://docs.gocardless.com/docs/api-reference/data-conventions#cursor-pagination)
         list of your Billing Request Templates.
 
         Args:

gocardless_pro/services/billing_requests_service.py

@@ -115,7 +115,7 @@ def collect_bank_account(self,identity,params=None, headers=None):
         endpoint will return a 422 - validation error on account_holder_name:
         "Account holder name does not match bank account details provided".
         Testing instructions are here
-        (https://developer.gocardless.com/developer-tools/scenario-simulators/#payer_name_verification)
+        (https://docs.gocardless.com/docs/developer-resources/scenario-simulators#payer-name-verification)
 
         Args:
               identity (string): Unique identifier, beginning with "BRQ".
@@ -219,7 +219,7 @@ def list(self,params=None, headers=None):
         """List Billing Requests.
 
         Returns a cursor-paginated
-        (https://developer.gocardless.com/api-reference/#api-usage-cursor-pagination)
+        (https://docs.gocardless.com/docs/api-reference/data-conventions#cursor-pagination)
         list of your billing requests.
 
         Args:

gocardless_pro/services/blocks_service.py

@@ -74,7 +74,7 @@ def list(self,params=None, headers=None):
         """List multiple blocks.
 
         Returns a cursor-paginated
-        (https://developer.gocardless.com/api-reference/#api-usage-cursor-pagination)
+        (https://docs.gocardless.com/docs/api-reference/data-conventions#cursor-pagination)
         list of your blocks.
 
         Args:

gocardless_pro/services/creditor_bank_accounts_service.py

@@ -51,7 +51,7 @@ def list(self,params=None, headers=None):
         """List creditor bank accounts.
 
         Returns a cursor-paginated
-        (https://developer.gocardless.com/api-reference/#api-usage-cursor-pagination)
+        (https://docs.gocardless.com/docs/api-reference/data-conventions#cursor-pagination)
         list of your creditor bank accounts.
 
         Args:

gocardless_pro/services/creditors_service.py

@@ -51,7 +51,7 @@ def list(self,params=None, headers=None):
         """List creditors.
 
         Returns a cursor-paginated
-        (https://developer.gocardless.com/api-reference/#api-usage-cursor-pagination)
+        (https://docs.gocardless.com/docs/api-reference/data-conventions#cursor-pagination)
         list of your creditors.
 
         Args:

gocardless_pro/services/currency_exchange_rates_service.py

@@ -21,7 +21,7 @@ def list(self,params=None, headers=None):
         """List exchange rates.
 
         Returns a cursor-paginated
-        (https://developer.gocardless.com/api-reference/#api-usage-cursor-pagination)
+        (https://docs.gocardless.com/docs/api-reference/data-conventions#cursor-pagination)
         list of all exchange rates.
 
         Args:

gocardless_pro/services/customer_bank_accounts_service.py

@@ -26,16 +26,16 @@ def create(self,params=None, headers=None):
 
         - 
         Local details
-        (https://developer.gocardless.com/api-reference/#appendix-local-bank-details)
+        (https://docs.gocardless.com/docs/api-reference/local-bank-details)
         - 
         IBAN
         - 
         Customer Bank Account Tokens
-        (https://developer.gocardless.com/api-reference/#javascript-flow-create-a-customer-bank-account-token)
+        (https://docs.gocardless.com/docs/collect-payments/integration-types/javascript-drop-in-flow)
 
         For more information on the different fields required in each country,
         see local bank details
-        (https://developer.gocardless.com/api-reference/#appendix-local-bank-details).
+        (https://docs.gocardless.com/docs/api-reference/local-bank-details).
 
         Args:
               params (dict, optional): Request body.
@@ -66,7 +66,7 @@ def list(self,params=None, headers=None):
         """List customer bank accounts.
 
         Returns a cursor-paginated
-        (https://developer.gocardless.com/api-reference/#api-usage-cursor-pagination)
+        (https://docs.gocardless.com/docs/api-reference/data-conventions#cursor-pagination)
         list of your bank accounts.
 
         Args:

gocardless_pro/services/customers_service.py

@@ -51,7 +51,7 @@ def list(self,params=None, headers=None):
         """List customers.
 
         Returns a cursor-paginated
-        (https://developer.gocardless.com/api-reference/#api-usage-cursor-pagination)
+        (https://docs.gocardless.com/docs/api-reference/data-conventions#cursor-pagination)
         list of your customers.
 
         Args:

gocardless_pro/services/events_service.py

@@ -21,7 +21,7 @@ def list(self,params=None, headers=None):
         """List events.
 
         Returns a cursor-paginated
-        (https://developer.gocardless.com/api-reference/#api-usage-cursor-pagination)
+        (https://docs.gocardless.com/docs/api-reference/data-conventions#cursor-pagination)
         list of your events.
 
         Important: This endpoint will no longer return events older than 18

gocardless_pro/services/instalment_schedules_service.py

@@ -25,7 +25,7 @@ def create_with_dates(self,params=None, headers=None):
         API is recommended if you know the specific dates you wish to charge.
         Otherwise,
         please check out the scheduling version
-        (https://developer.gocardless.com/api-reference/#instalment-schedules-create-with-schedule).
+        (https://docs.gocardless.com/docs/api-reference/instalment-schedule#create-with-schedule).
 
         The `instalments` property is an array of payment properties (`amount`
         and
@@ -75,7 +75,7 @@ def create_with_schedule(self,params=None, headers=None):
         For finer
         control over the individual dates, please check out the alternative
         version
-        (https://developer.gocardless.com/api-reference/#instalment-schedules-create-with-dates).
+        (https://docs.gocardless.com/docs/api-reference/instalment-schedule#create-with-schedule).
 
         It can take quite a while to create the associated payments, so the API
         will return
@@ -116,7 +116,7 @@ def list(self,params=None, headers=None):
         """List instalment schedules.
 
         Returns a cursor-paginated
-        (https://developer.gocardless.com/api-reference/#api-usage-cursor-pagination)
+        (https://docs.gocardless.com/docs/api-reference/data-conventions#cursor-pagination)
         list of your instalment schedules.
 
         Args:

gocardless_pro/services/logos_service.py

@@ -28,7 +28,7 @@ def create_for_creditor(self,params=None, headers=None):
         look
         great across your customer payment page and notification emails see
         here
-        (https://developer.gocardless.com/gc-embed/setting-up-branding#tips_for_uploading_your_logo).
+        (https://docs.gocardless.com/docs/gc-embed/setting-up-branding#tips-for-uploading-your-logo).
 
         Args:
               params (dict, optional): Request body.

gocardless_pro/services/mandate_import_entries_service.py

@@ -21,8 +21,8 @@ def create(self,params=None, headers=None):
         """Add a mandate import entry.
 
         For an existing mandate import
-        (https://developer.gocardless.com/api-reference/#core-endpoints-mandate-imports),
-        this endpoint can
+        (https://docs.gocardless.com/docs/api-reference/mandate-import), this
+        endpoint can
         be used to add individual mandates to be imported into GoCardless.
 
         You can add no more than 30,000 rows to a single mandate import.

gocardless_pro/services/mandate_imports_service.py

@@ -26,7 +26,7 @@ def create(self,params=None, headers=None):
         you've finished
         adding entries to an import, you should
         submit
-        (https://developer.gocardless.com/api-reference/#mandate-imports-submit-a-mandate-import)
+        (https://docs.gocardless.com/docs/api-reference/mandate-import#submit-a-mandate-import)
         it.
 
         Args:

gocardless_pro/services/mandate_pdfs_service.py

@@ -24,8 +24,7 @@ def create(self,params=None, headers=None):
 
         Customer and bank account details can be left blank (for a blank
         mandate), provided manually, or inferred from the ID of an existing
-        mandate
-        (https://developer.gocardless.com/api-reference/#core-endpoints-mandates).
+        mandate (https://docs.gocardless.com/docs/api-reference/mandate).
 
         By default, we'll generate PDF mandates in English.
 

gocardless_pro/services/mandates_service.py

@@ -51,7 +51,7 @@ def list(self,params=None, headers=None):
         """List mandates.
 
         Returns a cursor-paginated
-        (https://developer.gocardless.com/api-reference/#api-usage-cursor-pagination)
+        (https://docs.gocardless.com/docs/api-reference/data-conventions#cursor-pagination)
         list of your mandates.
 
         Args:

gocardless_pro/services/negative_balance_limits_service.py

@@ -21,7 +21,7 @@ def list(self,params=None, headers=None):
         """List negative balance limits.
 
         Returns a cursor-paginated
-        (https://developer.gocardless.com/api-reference/#api-usage-cursor-pagination)
+        (https://docs.gocardless.com/docs/api-reference/data-conventions#cursor-pagination)
         list of negative balance limits.
 
         Args:

gocardless_pro/services/outbound_payment_import_entries_service.py

@@ -21,7 +21,7 @@ def list(self,params=None, headers=None):
         """List outbound payment import entries.
 
         Returns a cursor-paginated
-        (https://developer.gocardless.com/api-reference/#api-usage-cursor-pagination)
+        (https://docs.gocardless.com/docs/api-reference/data-conventions#cursor-pagination)
         list of the entries for a given outbound payment import.
 
         Args:

gocardless_pro/services/outbound_payment_imports_service.py

@@ -74,7 +74,7 @@ def list(self,params=None, headers=None):
         """List outbound payment imports.
 
         Returns a cursor-paginated
-        (https://developer.gocardless.com/api-reference/#api-usage-cursor-pagination)
+        (https://docs.gocardless.com/docs/api-reference/data-conventions#cursor-pagination)
         list of your outbound payment imports.
 
         Args:

gocardless_pro/services/outbound_payments_service.py

@@ -148,7 +148,7 @@ def list(self,params=None, headers=None):
         """List outbound payments.
 
         Returns a cursor-paginated
-        (https://developer.gocardless.com/api-reference/#api-usage-cursor-pagination)
+        (https://docs.gocardless.com/docs/api-reference/data-conventions#cursor-pagination)
         list of outbound payments.
 
         Args:

gocardless_pro/services/payer_authorisations_service.py

@@ -26,7 +26,7 @@ def get(self,identity,params=None, headers=None):
         be used for polling the status of a Payer Authorisation.
 
         Deprecated:
-            Payer Authorisation is legacy API and cannot be used by new integrators. The Billing Request (https://developer.gocardless.com/api-reference/#billing-requests) API should be used for any new integrations.
+            Payer Authorisation is legacy API and cannot be used by new integrators. The Billing Request (https://docs.gocardless.com/docs/api-reference/billing-request) API should be used for any new integrations.
 
         Args:
               identity (string): Unique identifier, beginning with "PA".
@@ -35,7 +35,7 @@ def get(self,identity,params=None, headers=None):
         Returns:
               PayerAuthorisation
         """
-        warnings.warn("Payer Authorisation is legacy API and cannot be used by new integrators. The Billing Request (https://developer.gocardless.com/api-reference/#billing-requests) API should be used for any new integrations.",
+        warnings.warn("Payer Authorisation is legacy API and cannot be used by new integrators. The Billing Request (https://docs.gocardless.com/docs/api-reference/billing-request) API should be used for any new integrations.",
                       DeprecationWarning, stacklevel=2)
         path = self._sub_url_params('/payer_authorisations/:identity', {
 
@@ -59,15 +59,15 @@ def create(self,params=None, headers=None):
         able to implement a progressive solution, such as a multi-step form.
 
         Deprecated:
-            Payer Authorisation is legacy API and cannot be used by new integrators. The Billing Request (https://developer.gocardless.com/api-reference/#billing-requests) API should be used for any new integrations.
+            Payer Authorisation is legacy API and cannot be used by new integrators. The Billing Request (https://docs.gocardless.com/docs/api-reference/billing-request) API should be used for any new integrations.
 
         Args:
               params (dict, optional): Request body.
 
         Returns:
               PayerAuthorisation
         """
-        warnings.warn("Payer Authorisation is legacy API and cannot be used by new integrators. The Billing Request (https://developer.gocardless.com/api-reference/#billing-requests) API should be used for any new integrations.",
+        warnings.warn("Payer Authorisation is legacy API and cannot be used by new integrators. The Billing Request (https://docs.gocardless.com/docs/api-reference/billing-request) API should be used for any new integrations.",
                       DeprecationWarning, stacklevel=2)
         path = '/payer_authorisations'
 
@@ -102,7 +102,7 @@ def update(self,identity,params=None, headers=None):
         overrides the previously existing values. 
 
         Deprecated:
-            Payer Authorisation is legacy API and cannot be used by new integrators. The Billing Request (https://developer.gocardless.com/api-reference/#billing-requests) API should be used for any new integrations.
+            Payer Authorisation is legacy API and cannot be used by new integrators. The Billing Request (https://docs.gocardless.com/docs/api-reference/billing-request) API should be used for any new integrations.
 
         Args:
               identity (string): Unique identifier, beginning with "PA".
@@ -111,7 +111,7 @@ def update(self,identity,params=None, headers=None):
         Returns:
               PayerAuthorisation
         """
-        warnings.warn("Payer Authorisation is legacy API and cannot be used by new integrators. The Billing Request (https://developer.gocardless.com/api-reference/#billing-requests) API should be used for any new integrations.",
+        warnings.warn("Payer Authorisation is legacy API and cannot be used by new integrators. The Billing Request (https://docs.gocardless.com/docs/api-reference/billing-request) API should be used for any new integrations.",
                       DeprecationWarning, stacklevel=2)
         path = self._sub_url_params('/payer_authorisations/:identity', {
 
@@ -136,7 +136,7 @@ def submit(self,identity,params=None, headers=None):
         edited.
 
         Deprecated:
-            Payer Authorisation is legacy API and cannot be used by new integrators. The Billing Request (https://developer.gocardless.com/api-reference/#billing-requests) API should be used for any new integrations.
+            Payer Authorisation is legacy API and cannot be used by new integrators. The Billing Request (https://docs.gocardless.com/docs/api-reference/billing-request) API should be used for any new integrations.
 
         Args:
               identity (string): Unique identifier, beginning with "PA".
@@ -145,7 +145,7 @@ def submit(self,identity,params=None, headers=None):
         Returns:
               PayerAuthorisation
         """
-        warnings.warn("Payer Authorisation is legacy API and cannot be used by new integrators. The Billing Request (https://developer.gocardless.com/api-reference/#billing-requests) API should be used for any new integrations.",
+        warnings.warn("Payer Authorisation is legacy API and cannot be used by new integrators. The Billing Request (https://docs.gocardless.com/docs/api-reference/billing-request) API should be used for any new integrations.",
                       DeprecationWarning, stacklevel=2)
         path = self._sub_url_params('/payer_authorisations/:identity/actions/submit', {
 
@@ -174,7 +174,7 @@ def confirm(self,identity,params=None, headers=None):
         verification mechanism (upcoming feature).
 
         Deprecated:
-            Payer Authorisation is legacy API and cannot be used by new integrators. The Billing Request (https://developer.gocardless.com/api-reference/#billing-requests) API should be used for any new integrations.
+            Payer Authorisation is legacy API and cannot be used by new integrators. The Billing Request (https://docs.gocardless.com/docs/api-reference/billing-request) API should be used for any new integrations.
 
         Args:
               identity (string): Unique identifier, beginning with "PA".
@@ -183,7 +183,7 @@ def confirm(self,identity,params=None, headers=None):
         Returns:
               PayerAuthorisation
         """
-        warnings.warn("Payer Authorisation is legacy API and cannot be used by new integrators. The Billing Request (https://developer.gocardless.com/api-reference/#billing-requests) API should be used for any new integrations.",
+        warnings.warn("Payer Authorisation is legacy API and cannot be used by new integrators. The Billing Request (https://docs.gocardless.com/docs/api-reference/billing-request) API should be used for any new integrations.",
                       DeprecationWarning, stacklevel=2)
         path = self._sub_url_params('/payer_authorisations/:identity/actions/confirm', {
 

gocardless_pro/services/payment_account_transactions_service.py

@@ -23,7 +23,7 @@ def get(self,identity,params=None, headers=None):
         Retrieves the details of an existing payment account transaction.
 
         Args:
-              identity (string): The unique ID of the bank account (https://developer.gocardless.com/api-reference/#core-endpoints-creditor-bank-accounts) which happens to be the payment account.
+              identity (string): The unique ID of the bank account (https://docs.gocardless.com/docs/api-reference/creditor-bank-account) which happens to be the payment account.
               params (dict, optional): Query string parameters.
 
         Returns:
@@ -46,7 +46,7 @@ def list(self,identity,params=None, headers=None):
         List transactions for a given payment account.
 
         Args:
-              identity (string): The unique ID of the bank account (https://developer.gocardless.com/api-reference/#core-endpoints-creditor-bank-accounts) which happens to be the payment account.
+              identity (string): The unique ID of the bank account (https://docs.gocardless.com/docs/api-reference/creditor-bank-account) which happens to be the payment account.
               params (dict, optional): Query string parameters.
 
         Returns:

gocardless_pro/services/payment_accounts_service.py

@@ -44,7 +44,7 @@ def list(self,params=None, headers=None):
         """List payment accounts.
 
         Returns a cursor-paginated
-        (https://developer.gocardless.com/api-reference/#api-usage-cursor-pagination)
+        (https://docs.gocardless.com/docs/api-reference/data-conventions#cursor-pagination)
         list of your payment accounts.
 
         Args: