From bc2e91d639aa10e90ed4d0f2678c6c016d10ef53 Mon Sep 17 00:00:00 2001 From: "gocardless-ci-robot[bot]" <123969075+gocardless-ci-robot[bot]@users.noreply.github.com> Date: Thu, 29 Oct 2026 11:56:58 +0000 Subject: [PATCH] Changes generated by f6d96621c1e450bc0325664828bbdb9df7169b20 This commit was automatically created from gocardless/client-library-templates@f6d96621c1e450bc0325664828bbdb9df7169b20 by the `push-files` action. Workflow run: https://github.com/gocardless/client-library-templates/actions/runs/40868931658 --- gocardless_pro/services/balances_service.py | 2 +- .../services/bank_account_details_service.py | 2 +- .../services/bank_details_lookups_service.py | 8 +++---- .../billing_request_templates_service.py | 2 +- .../services/billing_requests_service.py | 4 ++-- gocardless_pro/services/blocks_service.py | 2 +- .../creditor_bank_accounts_service.py | 2 +- gocardless_pro/services/creditors_service.py | 2 +- .../currency_exchange_rates_service.py | 2 +- .../customer_bank_accounts_service.py | 8 +++---- gocardless_pro/services/customers_service.py | 2 +- gocardless_pro/services/events_service.py | 2 +- .../services/instalment_schedules_service.py | 6 +++--- gocardless_pro/services/logos_service.py | 2 +- .../mandate_import_entries_service.py | 4 ++-- .../services/mandate_imports_service.py | 2 +- .../services/mandate_pdfs_service.py | 3 +-- gocardless_pro/services/mandates_service.py | 2 +- .../negative_balance_limits_service.py | 2 +- ...outbound_payment_import_entries_service.py | 2 +- .../outbound_payment_imports_service.py | 2 +- .../services/outbound_payments_service.py | 2 +- .../services/payer_authorisations_service.py | 20 +++++++++--------- .../payment_account_transactions_service.py | 4 ++-- .../services/payment_accounts_service.py | 2 +- gocardless_pro/services/payments_service.py | 10 ++++----- .../services/payout_items_service.py | 2 +- gocardless_pro/services/payouts_service.py | 4 ++-- .../services/redirect_flows_service.py | 21 +++++++++---------- gocardless_pro/services/refunds_service.py | 2 +- .../services/scheme_identifiers_service.py | 2 +- .../services/subscriptions_service.py | 4 ++-- gocardless_pro/services/tax_rates_service.py | 2 +- gocardless_pro/services/webhooks_service.py | 2 +- 34 files changed, 69 insertions(+), 71 deletions(-) diff --git a/gocardless_pro/services/balances_service.py b/gocardless_pro/services/balances_service.py index 4583adcd..3cf814a9 100644 --- a/gocardless_pro/services/balances_service.py +++ b/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. diff --git a/gocardless_pro/services/bank_account_details_service.py b/gocardless_pro/services/bank_account_details_service.py index f2f8c9a7..0112dec5 100644 --- a/gocardless_pro/services/bank_account_details_service.py +++ b/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: diff --git a/gocardless_pro/services/bank_details_lookups_service.py b/gocardless_pro/services/bank_details_lookups_service.py index 06c2ff56..ea81cb7e 100644 --- a/gocardless_pro/services/bank_details_lookups_service.py +++ b/gocardless_pro/services/bank_details_lookups_service.py @@ -35,8 +35,8 @@ 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 @@ -44,8 +44,8 @@ def create(self,params=None, headers=None): 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 diff --git a/gocardless_pro/services/billing_request_templates_service.py b/gocardless_pro/services/billing_request_templates_service.py index 27839fe9..5c3c0483 100644 --- a/gocardless_pro/services/billing_request_templates_service.py +++ b/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: diff --git a/gocardless_pro/services/billing_requests_service.py b/gocardless_pro/services/billing_requests_service.py index 77da24e2..4044b480 100644 --- a/gocardless_pro/services/billing_requests_service.py +++ b/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: diff --git a/gocardless_pro/services/blocks_service.py b/gocardless_pro/services/blocks_service.py index 781a79b9..1a6a8ea9 100644 --- a/gocardless_pro/services/blocks_service.py +++ b/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: diff --git a/gocardless_pro/services/creditor_bank_accounts_service.py b/gocardless_pro/services/creditor_bank_accounts_service.py index 65a8c066..072cfd10 100644 --- a/gocardless_pro/services/creditor_bank_accounts_service.py +++ b/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: diff --git a/gocardless_pro/services/creditors_service.py b/gocardless_pro/services/creditors_service.py index 43dd3b12..14695962 100644 --- a/gocardless_pro/services/creditors_service.py +++ b/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: diff --git a/gocardless_pro/services/currency_exchange_rates_service.py b/gocardless_pro/services/currency_exchange_rates_service.py index 75899546..6f283dad 100644 --- a/gocardless_pro/services/currency_exchange_rates_service.py +++ b/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: diff --git a/gocardless_pro/services/customer_bank_accounts_service.py b/gocardless_pro/services/customer_bank_accounts_service.py index c62ba8f4..8f64632f 100644 --- a/gocardless_pro/services/customer_bank_accounts_service.py +++ b/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: diff --git a/gocardless_pro/services/customers_service.py b/gocardless_pro/services/customers_service.py index 383661ef..94583d3c 100644 --- a/gocardless_pro/services/customers_service.py +++ b/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: diff --git a/gocardless_pro/services/events_service.py b/gocardless_pro/services/events_service.py index f8068f46..3332736e 100644 --- a/gocardless_pro/services/events_service.py +++ b/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 diff --git a/gocardless_pro/services/instalment_schedules_service.py b/gocardless_pro/services/instalment_schedules_service.py index b9f0dae9..153f0bc3 100644 --- a/gocardless_pro/services/instalment_schedules_service.py +++ b/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: diff --git a/gocardless_pro/services/logos_service.py b/gocardless_pro/services/logos_service.py index 125d296a..57959223 100644 --- a/gocardless_pro/services/logos_service.py +++ b/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. diff --git a/gocardless_pro/services/mandate_import_entries_service.py b/gocardless_pro/services/mandate_import_entries_service.py index db74ed3f..17e58aa7 100644 --- a/gocardless_pro/services/mandate_import_entries_service.py +++ b/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. diff --git a/gocardless_pro/services/mandate_imports_service.py b/gocardless_pro/services/mandate_imports_service.py index 7fb1d161..b92398bb 100644 --- a/gocardless_pro/services/mandate_imports_service.py +++ b/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: diff --git a/gocardless_pro/services/mandate_pdfs_service.py b/gocardless_pro/services/mandate_pdfs_service.py index 75aace89..4d02947d 100644 --- a/gocardless_pro/services/mandate_pdfs_service.py +++ b/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. diff --git a/gocardless_pro/services/mandates_service.py b/gocardless_pro/services/mandates_service.py index 12e834d7..af7e3ad9 100644 --- a/gocardless_pro/services/mandates_service.py +++ b/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: diff --git a/gocardless_pro/services/negative_balance_limits_service.py b/gocardless_pro/services/negative_balance_limits_service.py index 0c925e3a..7c1840b7 100644 --- a/gocardless_pro/services/negative_balance_limits_service.py +++ b/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: diff --git a/gocardless_pro/services/outbound_payment_import_entries_service.py b/gocardless_pro/services/outbound_payment_import_entries_service.py index 4060f90c..ce46b558 100644 --- a/gocardless_pro/services/outbound_payment_import_entries_service.py +++ b/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: diff --git a/gocardless_pro/services/outbound_payment_imports_service.py b/gocardless_pro/services/outbound_payment_imports_service.py index 4d5ad283..5bc17e47 100644 --- a/gocardless_pro/services/outbound_payment_imports_service.py +++ b/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: diff --git a/gocardless_pro/services/outbound_payments_service.py b/gocardless_pro/services/outbound_payments_service.py index 2293cf9f..ef560c6b 100644 --- a/gocardless_pro/services/outbound_payments_service.py +++ b/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: diff --git a/gocardless_pro/services/payer_authorisations_service.py b/gocardless_pro/services/payer_authorisations_service.py index d6ee7672..acb4145d 100644 --- a/gocardless_pro/services/payer_authorisations_service.py +++ b/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,7 +59,7 @@ 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. @@ -67,7 +67,7 @@ def create(self,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 = '/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', { diff --git a/gocardless_pro/services/payment_account_transactions_service.py b/gocardless_pro/services/payment_account_transactions_service.py index f37487ad..29f6eb6c 100644 --- a/gocardless_pro/services/payment_account_transactions_service.py +++ b/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: diff --git a/gocardless_pro/services/payment_accounts_service.py b/gocardless_pro/services/payment_accounts_service.py index a2d6924e..b9d3493c 100644 --- a/gocardless_pro/services/payment_accounts_service.py +++ b/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: diff --git a/gocardless_pro/services/payments_service.py b/gocardless_pro/services/payments_service.py index 6b599a7d..fc73baae 100644 --- a/gocardless_pro/services/payments_service.py +++ b/gocardless_pro/services/payments_service.py @@ -23,10 +23,10 @@ def create(self,params=None, headers=None): Creates a new payment object. This fails with a `mandate_is_inactive` error if the linked mandate - (https://developer.gocardless.com/api-reference/#core-endpoints-mandates) - is cancelled or has failed. Payments can be created against mandates - with status of: `pending_customer_approval`, `pending_submission`, - `submitted`, and `active`. + (https://docs.gocardless.com/docs/api-reference/mandate) is cancelled + or has failed. Payments can be created against mandates with status of: + `pending_customer_approval`, `pending_submission`, `submitted`, and + `active`. Args: params (dict, optional): Request body. @@ -57,7 +57,7 @@ def list(self,params=None, headers=None): """List 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 your payments. Args: diff --git a/gocardless_pro/services/payout_items_service.py b/gocardless_pro/services/payout_items_service.py index 121d7bf2..8fbc9aa5 100644 --- a/gocardless_pro/services/payout_items_service.py +++ b/gocardless_pro/services/payout_items_service.py @@ -21,7 +21,7 @@ def list(self,params=None, headers=None): """Get all payout items in a single payout. 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 items in the payout. This endpoint only serves requests for payouts created in the last 6 diff --git a/gocardless_pro/services/payouts_service.py b/gocardless_pro/services/payouts_service.py index e9e00be0..eab5af2a 100644 --- a/gocardless_pro/services/payouts_service.py +++ b/gocardless_pro/services/payouts_service.py @@ -21,7 +21,7 @@ def list(self,params=None, headers=None): """List payouts. 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 payouts. Args: @@ -50,7 +50,7 @@ def get(self,identity,params=None, headers=None): Retrieves the details of a single payout. For an example of how to reconcile the transactions in a payout, see this guide - (https://developer.gocardless.com/api-reference/#events-reconciling-payouts-with-events). + (https://docs.gocardless.com/docs/collect-payments/managing-payments/reconciling-payouts). Args: identity (string): Unique identifier, beginning with "PO". diff --git a/gocardless_pro/services/redirect_flows_service.py b/gocardless_pro/services/redirect_flows_service.py index f467f4b0..efa28839 100644 --- a/gocardless_pro/services/redirect_flows_service.py +++ b/gocardless_pro/services/redirect_flows_service.py @@ -26,7 +26,7 @@ def create(self,params=None, headers=None): customer to the GoCardless hosted payment pages. Deprecated: - Redirect Flows are legacy APIs and cannot be used by new integrators. The Billing Request flow (https://developer.gocardless.com/api-reference/#billing-requests) API should be used for your payment flows. + Redirect Flows are legacy APIs and cannot be used by new integrators. The Billing Request flow (https://docs.gocardless.com/docs/api-reference/billing-request) API should be used for your payment flows. Args: params (dict, optional): Request body. @@ -34,7 +34,7 @@ def create(self,params=None, headers=None): Returns: RedirectFlow """ - warnings.warn("Redirect Flows are legacy APIs and cannot be used by new integrators. The Billing Request flow (https://developer.gocardless.com/api-reference/#billing-requests) API should be used for your payment flows.", + warnings.warn("Redirect Flows are legacy APIs and cannot be used by new integrators. The Billing Request flow (https://docs.gocardless.com/docs/api-reference/billing-request) API should be used for your payment flows.", DeprecationWarning, stacklevel=2) path = '/redirect_flows' @@ -61,7 +61,7 @@ def get(self,identity,params=None, headers=None): Returns all details about a single redirect flow Deprecated: - Redirect Flows are legacy APIs and cannot be used by new integrators. The Billing Request flow (https://developer.gocardless.com/api-reference/#billing-requests) API should be used for your payment flows. + Redirect Flows are legacy APIs and cannot be used by new integrators. The Billing Request flow (https://docs.gocardless.com/docs/api-reference/billing-request) API should be used for your payment flows. Args: identity (string): Unique identifier, beginning with "RE". @@ -70,7 +70,7 @@ def get(self,identity,params=None, headers=None): Returns: RedirectFlow """ - warnings.warn("Redirect Flows are legacy APIs and cannot be used by new integrators. The Billing Request flow (https://developer.gocardless.com/api-reference/#billing-requests) API should be used for your payment flows.", + warnings.warn("Redirect Flows are legacy APIs and cannot be used by new integrators. The Billing Request flow (https://docs.gocardless.com/docs/api-reference/billing-request) API should be used for your payment flows.", DeprecationWarning, stacklevel=2) path = self._sub_url_params('/redirect_flows/:identity', { @@ -87,11 +87,10 @@ def complete(self,identity,params=None, headers=None): """Complete a redirect flow. This creates a customer - (https://developer.gocardless.com/api-reference/#core-endpoints-customers), - customer bank account - (https://developer.gocardless.com/api-reference/#core-endpoints-customer-bank-accounts), - and mandate - (https://developer.gocardless.com/api-reference/#core-endpoints-mandates) + (https://docs.gocardless.com/docs/api-reference/customer), customer + bank account + (https://docs.gocardless.com/docs/api-reference/customer-bank-account), + and mandate (https://docs.gocardless.com/docs/api-reference/mandate) using the details supplied by your customer and returns the ID of the created mandate. @@ -103,7 +102,7 @@ def complete(self,identity,params=None, headers=None): created. Deprecated: - Redirect Flows are legacy APIs and cannot be used by new integrators. The Billing Request flow (https://developer.gocardless.com/api-reference/#billing-requests) API should be used for your payment flows. + Redirect Flows are legacy APIs and cannot be used by new integrators. The Billing Request flow (https://docs.gocardless.com/docs/api-reference/billing-request) API should be used for your payment flows. Args: identity (string): Unique identifier, beginning with "RE". @@ -112,7 +111,7 @@ def complete(self,identity,params=None, headers=None): Returns: RedirectFlow """ - warnings.warn("Redirect Flows are legacy APIs and cannot be used by new integrators. The Billing Request flow (https://developer.gocardless.com/api-reference/#billing-requests) API should be used for your payment flows.", + warnings.warn("Redirect Flows are legacy APIs and cannot be used by new integrators. The Billing Request flow (https://docs.gocardless.com/docs/api-reference/billing-request) API should be used for your payment flows.", DeprecationWarning, stacklevel=2) path = self._sub_url_params('/redirect_flows/:identity/actions/complete', { diff --git a/gocardless_pro/services/refunds_service.py b/gocardless_pro/services/refunds_service.py index 70a06326..9521add6 100644 --- a/gocardless_pro/services/refunds_service.py +++ b/gocardless_pro/services/refunds_service.py @@ -63,7 +63,7 @@ def list(self,params=None, headers=None): """List refunds. 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 refunds. Args: diff --git a/gocardless_pro/services/scheme_identifiers_service.py b/gocardless_pro/services/scheme_identifiers_service.py index 8c56d1c1..f9b31a34 100644 --- a/gocardless_pro/services/scheme_identifiers_service.py +++ b/gocardless_pro/services/scheme_identifiers_service.py @@ -89,7 +89,7 @@ def list(self,params=None, headers=None): """List scheme identifiers. 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 scheme identifiers. Args: diff --git a/gocardless_pro/services/subscriptions_service.py b/gocardless_pro/services/subscriptions_service.py index 9fd8837d..949872e5 100644 --- a/gocardless_pro/services/subscriptions_service.py +++ b/gocardless_pro/services/subscriptions_service.py @@ -51,7 +51,7 @@ def list(self,params=None, headers=None): """List subscriptions. 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 subscriptions. Please note if the subscriptions are related to customers who have been removed, they will not be shown in the response. @@ -164,7 +164,7 @@ def pause(self,identity,params=None, headers=None): When `pause_cycles` is omitted the subscription is paused until the resume endpoint - (https://developer.gocardless.com/api-reference/#subscriptions-resume-a-subscription) + (https://docs.gocardless.com/docs/api-reference/subscription#resume-a-subscription) is called. If the subscription is collecting a fixed number of payments, `end_date` will be set to `null`. diff --git a/gocardless_pro/services/tax_rates_service.py b/gocardless_pro/services/tax_rates_service.py index a014b143..f820e503 100644 --- a/gocardless_pro/services/tax_rates_service.py +++ b/gocardless_pro/services/tax_rates_service.py @@ -21,7 +21,7 @@ def list(self,params=None, headers=None): """List tax 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 tax rates. Args: diff --git a/gocardless_pro/services/webhooks_service.py b/gocardless_pro/services/webhooks_service.py index 30f9841d..e2c31290 100644 --- a/gocardless_pro/services/webhooks_service.py +++ b/gocardless_pro/services/webhooks_service.py @@ -21,7 +21,7 @@ def list(self,params=None, headers=None): """List webhooks. 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 webhooks. Args: