Changes from gocardless/client-library-templates

src/services/balanceService.ts

@@ -19,8 +19,7 @@ interface BalanceListRequest {
 
   before?: string;
 
-  // ID of a creditor
-  // (https://developer.gocardless.com/api-reference/#core-endpoints-creditors).
+  // ID of a creditor (https://docs.gocardless.com/docs/api-reference/creditor).
 
   creditor: string;
 

src/services/bankAuthorisationService.ts

@@ -27,12 +27,12 @@ interface BankAuthorisationCreateRequest {
   // Please note: bank authorisations can still fail despite an `outcome=success`
   // on the `redirect_uri`. It is therefore recommended to wait for the relevant
   // bank authorisation event, such as `BANK_AUTHORISATION_AUTHORISED`
-  // (https://developer.gocardless.com/api-reference/#billing-request-bankauthorisationauthorised),
+  // (https://docs.gocardless.com/docs/api-reference/events/billing-request),
   // `BANK_AUTHORISATION_DENIED`
-  // (https://developer.gocardless.com/api-reference/#billing-request-bankauthorisationdenied),
-  // or `BANK_AUTHORISATION_FAILED`
-  // (https://developer.gocardless.com/api-reference/#billing-request-bankauthorisationfailed)
-  // in order to show the correct outcome to the user.
+  // (https://docs.gocardless.com/docs/api-reference/events/billing-request), or
+  // `BANK_AUTHORISATION_FAILED`
+  // (https://docs.gocardless.com/docs/api-reference/events/billing-request) in
+  // order to show the correct outcome to the user.
   //
   // The BillingRequestFlow ID will also be appended to the `redirect_uri` as
   // query parameter `id=BRF123`.

src/services/bankDetailsLookupService.ts

@@ -18,20 +18,20 @@ interface BankDetailsLookupCreateRequest {
   account_holder_name?: string;
 
   // Bank account number - see local details
-  // (https://developer.gocardless.com/api-reference/#appendix-local-bank-details)
-  // for more information. Alternatively you can provide an `iban`.
+  // (https://docs.gocardless.com/docs/api-reference/local-bank-details) for more
+  // information. Alternatively you can provide an `iban`.
 
   account_number?: string;
 
   // Bank code - see local details
-  // (https://developer.gocardless.com/api-reference/#appendix-local-bank-details)
-  // for more information. Alternatively you can provide an `iban`.
+  // (https://docs.gocardless.com/docs/api-reference/local-bank-details) for more
+  // information. Alternatively you can provide an `iban`.
 
   bank_code?: string;
 
   // Branch code - see local details
-  // (https://developer.gocardless.com/api-reference/#appendix-local-bank-details)
-  // for more information. Alternatively you can provide an `iban`.
+  // (https://docs.gocardless.com/docs/api-reference/local-bank-details) for more
+  // information. Alternatively you can provide an `iban`.
 
   branch_code?: string;
 
@@ -42,8 +42,7 @@ interface BankDetailsLookupCreateRequest {
   country_code?: string;
 
   // International Bank Account Number. Alternatively you can provide local
-  // details
-  // (https://developer.gocardless.com/api-reference/#appendix-local-bank-details).
+  // details (https://docs.gocardless.com/docs/api-reference/local-bank-details).
 
   iban?: string;
 }

src/services/billingRequestService.ts

@@ -16,7 +16,7 @@ interface BillingRequestCreateRequest {
   // Should not be set if GoCardless payment intelligence feature is used.
   //
   // See Billing Requests: Retain customers with Fallbacks
-  // (https://developer.gocardless.com/billing-requests/retain-customers-with-fallbacks/)
+  // (https://docs.gocardless.com/docs/optimise/retain-customers-with-fallbacks)
   // for more information.
 
   fallback_enabled?: boolean;
@@ -47,8 +47,8 @@ interface BillingRequestCreateRequest {
   // or type of service/goods the payment relates to, improving straight-through
   // processing and compliance.
   // See VRP Commercial Payment Purpose Codes
-  // (https://developer.gocardless.com/vrp-commercial-payment-purpose-codes/) for
-  // the complete list of valid codes.
+  // (https://docs.gocardless.com/docs/collect-payments/scheme-guidance/vrp-purpose-codes)
+  // for the complete list of valid codes.
 
   payment_purpose_code?: string;
 
@@ -59,8 +59,8 @@ interface BillingRequestCreateRequest {
   // set of pre-defined categories. Provides context on the nature and reason for
   // the payment to facilitate processing and compliance.
   // See Billing Request Purpose Codes
-  // (https://developer.gocardless.com/billing-request-purpose-codes/) for the
-  // complete list of valid codes.
+  // (https://docs.gocardless.com/docs/collect-payments/scheme-guidance/billing-request-purpose-codes)
+  // for the complete list of valid codes.
 
   purpose_code?: `${Types.BillingRequestPurposeCode}`;
 
@@ -82,39 +82,39 @@ interface BillingRequestCollectBankAccountRequest {
   // transliterated, upcased, and truncated to 18 characters in bank submissions.
   // This field is required unless the request includes a customer bank account
   // token
-  // (https://developer.gocardless.com/api-reference/#javascript-flow-customer-bank-account-tokens).
+  // (https://docs.gocardless.com/docs/collect-payments/integration-types/javascript-drop-in-flow).
 
   account_holder_name?: string;
 
   // Bank account number - see local details
-  // (https://developer.gocardless.com/api-reference/#appendix-local-bank-details)
-  // for more information. Alternatively you can provide an `iban`.
+  // (https://docs.gocardless.com/docs/api-reference/local-bank-details) for more
+  // information. Alternatively you can provide an `iban`.
 
   account_number?: string;
 
   // Account number suffix (only for bank accounts denominated in NZD) - see local
   // details
-  // (https://developer.gocardless.com/api-reference/#local-bank-details-new-zealand)
+  // (https://docs.gocardless.com/docs/api-reference/local-bank-details#new-zealand)
   // for more information.
 
   account_number_suffix?: string;
 
   // Bank account type. Required for USD-denominated bank accounts. Must not be
   // provided for bank accounts in other currencies. See local details
-  // (https://developer.gocardless.com/api-reference/#local-bank-details-united-states)
+  // (https://docs.gocardless.com/docs/api-reference/local-bank-details#united-states)
   // for more information.
 
   account_type?: `${Types.BillingRequestAccountType}`;
 
   // Bank code - see local details
-  // (https://developer.gocardless.com/api-reference/#appendix-local-bank-details)
-  // for more information. Alternatively you can provide an `iban`.
+  // (https://docs.gocardless.com/docs/api-reference/local-bank-details) for more
+  // information. Alternatively you can provide an `iban`.
 
   bank_code?: string;
 
   // Branch code - see local details
-  // (https://developer.gocardless.com/api-reference/#appendix-local-bank-details)
-  // for more information. Alternatively you can provide an `iban`.
+  // (https://docs.gocardless.com/docs/api-reference/local-bank-details) for more
+  // information. Alternatively you can provide an `iban`.
 
   branch_code?: string;
 
@@ -132,11 +132,10 @@ interface BillingRequestCollectBankAccountRequest {
   currency?: string;
 
   // International Bank Account Number. Alternatively you can provide local
-  // details
-  // (https://developer.gocardless.com/api-reference/#appendix-local-bank-details).
+  // details (https://docs.gocardless.com/docs/api-reference/local-bank-details).
   // IBANs are not accepted for Swedish bank accounts denominated in SEK - you
   // must supply local details
-  // (https://developer.gocardless.com/api-reference/#local-bank-details-sweden).
+  // (https://docs.gocardless.com/docs/api-reference/local-bank-details#sweden).
 
   iban?: string;
 
@@ -190,8 +189,7 @@ interface BillingRequestListRequest {
 
   before?: string;
 
-  // ID of a customer
-  // (https://developer.gocardless.com/api-reference/#core-endpoints-customers).
+  // ID of a customer (https://docs.gocardless.com/docs/api-reference/customer).
   // If specified, this endpoint will return all requests for the given customer.
 
   customer?: string;

src/services/billingRequestWithActionService.ts

@@ -19,7 +19,7 @@ interface BillingRequestWithActionCreateWithActionsRequest {
   // Should not be set if GoCardless payment intelligence feature is used.
   //
   // See Billing Requests: Retain customers with Fallbacks
-  // (https://developer.gocardless.com/billing-requests/retain-customers-with-fallbacks/)
+  // (https://docs.gocardless.com/docs/optimise/retain-customers-with-fallbacks)
   // for more information.
 
   fallback_enabled?: boolean;
@@ -47,8 +47,8 @@ interface BillingRequestWithActionCreateWithActionsRequest {
   // or type of service/goods the payment relates to, improving straight-through
   // processing and compliance.
   // See VRP Commercial Payment Purpose Codes
-  // (https://developer.gocardless.com/vrp-commercial-payment-purpose-codes/) for
-  // the complete list of valid codes.
+  // (https://docs.gocardless.com/docs/collect-payments/scheme-guidance/vrp-purpose-codes)
+  // for the complete list of valid codes.
 
   payment_purpose_code?: string;
 
@@ -59,8 +59,8 @@ interface BillingRequestWithActionCreateWithActionsRequest {
   // set of pre-defined categories. Provides context on the nature and reason for
   // the payment to facilitate processing and compliance.
   // See Billing Request Purpose Codes
-  // (https://developer.gocardless.com/billing-request-purpose-codes/) for the
-  // complete list of valid codes.
+  // (https://docs.gocardless.com/docs/collect-payments/scheme-guidance/billing-request-purpose-codes)
+  // for the complete list of valid codes.
 
   purpose_code?: `${Types.BillingRequestWithActionPurposeCode}`;
 }

src/services/creditorBankAccountService.ts

@@ -13,33 +13,33 @@ interface CreditorBankAccountListResponse extends Types.APIResponse {
 interface CreditorBankAccountCreateRequest {
   // Name of the account holder, as known by the bank. Usually this is the same as
   // the name stored with the linked creditor
-  // (https://developer.gocardless.com/api-reference/#core-endpoints-creditors).
-  // This field will be transliterated, upcased and truncated to 18 characters.
+  // (https://docs.gocardless.com/docs/api-reference/creditor). This field will be
+  // transliterated, upcased and truncated to 18 characters.
 
   account_holder_name: string;
 
   // Bank account number - see local details
-  // (https://developer.gocardless.com/api-reference/#appendix-local-bank-details)
-  // for more information. Alternatively you can provide an `iban`.
+  // (https://docs.gocardless.com/docs/api-reference/local-bank-details) for more
+  // information. Alternatively you can provide an `iban`.
 
   account_number?: string;
 
   // Bank account type. Required for USD-denominated bank accounts. Must not be
   // provided for bank accounts in other currencies. See local details
-  // (https://developer.gocardless.com/api-reference/#local-bank-details-united-states)
+  // (https://docs.gocardless.com/docs/api-reference/local-bank-details#united-states)
   // for more information.
 
   account_type?: `${Types.CreditorBankAccountAccountType}`;
 
   // Bank code - see local details
-  // (https://developer.gocardless.com/api-reference/#appendix-local-bank-details)
-  // for more information. Alternatively you can provide an `iban`.
+  // (https://docs.gocardless.com/docs/api-reference/local-bank-details) for more
+  // information. Alternatively you can provide an `iban`.
 
   bank_code?: string;
 
   // Branch code - see local details
-  // (https://developer.gocardless.com/api-reference/#appendix-local-bank-details)
-  // for more information. Alternatively you can provide an `iban`.
+  // (https://docs.gocardless.com/docs/api-reference/local-bank-details) for more
+  // information. Alternatively you can provide an `iban`.
 
   branch_code?: string;
 
@@ -57,11 +57,10 @@ interface CreditorBankAccountCreateRequest {
   currency?: string;
 
   // International Bank Account Number. Alternatively you can provide local
-  // details
-  // (https://developer.gocardless.com/api-reference/#appendix-local-bank-details).
+  // details (https://docs.gocardless.com/docs/api-reference/local-bank-details).
   // IBANs are not accepted for Swedish bank accounts denominated in SEK - you
   // must supply local details
-  // (https://developer.gocardless.com/api-reference/#local-bank-details-sweden).
+  // (https://docs.gocardless.com/docs/api-reference/local-bank-details#sweden).
 
   iban?: string;
 

src/services/customerBankAccountService.ts

@@ -16,32 +16,32 @@ interface CustomerBankAccountCreateRequest {
   // transliterated, upcased, and truncated to 18 characters in bank submissions.
   // This field is required unless the request includes a customer bank account
   // token
-  // (https://developer.gocardless.com/api-reference/#javascript-flow-customer-bank-account-tokens).
+  // (https://docs.gocardless.com/docs/collect-payments/integration-types/javascript-drop-in-flow).
 
   account_holder_name?: string;
 
   // Bank account number - see local details
-  // (https://developer.gocardless.com/api-reference/#appendix-local-bank-details)
-  // for more information. Alternatively you can provide an `iban`.
+  // (https://docs.gocardless.com/docs/api-reference/local-bank-details) for more
+  // information. Alternatively you can provide an `iban`.
 
   account_number?: string;
 
   // Bank account type. Required for USD-denominated bank accounts. Must not be
   // provided for bank accounts in other currencies. See local details
-  // (https://developer.gocardless.com/api-reference/#local-bank-details-united-states)
+  // (https://docs.gocardless.com/docs/api-reference/local-bank-details#united-states)
   // for more information.
 
   account_type?: `${Types.CustomerBankAccountAccountType}`;
 
   // Bank code - see local details
-  // (https://developer.gocardless.com/api-reference/#appendix-local-bank-details)
-  // for more information. Alternatively you can provide an `iban`.
+  // (https://docs.gocardless.com/docs/api-reference/local-bank-details) for more
+  // information. Alternatively you can provide an `iban`.
 
   bank_code?: string;
 
   // Branch code - see local details
-  // (https://developer.gocardless.com/api-reference/#appendix-local-bank-details)
-  // for more information. Alternatively you can provide an `iban`.
+  // (https://docs.gocardless.com/docs/api-reference/local-bank-details) for more
+  // information. Alternatively you can provide an `iban`.
 
   branch_code?: string;
 
@@ -59,11 +59,10 @@ interface CustomerBankAccountCreateRequest {
   currency?: string;
 
   // International Bank Account Number. Alternatively you can provide local
-  // details
-  // (https://developer.gocardless.com/api-reference/#appendix-local-bank-details).
+  // details (https://docs.gocardless.com/docs/api-reference/local-bank-details).
   // IBANs are not accepted for Swedish bank accounts denominated in SEK - you
   // must supply local details
-  // (https://developer.gocardless.com/api-reference/#local-bank-details-sweden).
+  // (https://docs.gocardless.com/docs/api-reference/local-bank-details#sweden).
 
   iban?: string;
 

src/services/customerService.ts

@@ -62,7 +62,7 @@ interface CustomerCreateRequest {
   // ISO 639-1 (https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) code. Used
   // as the language for notification emails sent by GoCardless if your
   // organisation does not send its own (see compliance requirements
-  // (https://developer.gocardless.com/api-reference/#appendix-compliance-requirements)).
+  // (https://docs.gocardless.com/docs/api-reference/compliance-requirements)).
   // Currently only "en", "fr", "de", "pt", "es", "it", "nl", "da", "nb", "sl",
   // "sv" are supported. If this is not provided, the language will be chosen
   // based on the `country_code` (if supplied) or default to "en".
@@ -193,7 +193,7 @@ interface CustomerUpdateRequest {
   // ISO 639-1 (https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) code. Used
   // as the language for notification emails sent by GoCardless if your
   // organisation does not send its own (see compliance requirements
-  // (https://developer.gocardless.com/api-reference/#appendix-compliance-requirements)).
+  // (https://docs.gocardless.com/docs/api-reference/compliance-requirements)).
   // Currently only "en", "fr", "de", "pt", "es", "it", "nl", "da", "nb", "sl",
   // "sv" are supported. If this is not provided, the language will be chosen
   // based on the `country_code` (if supplied) or default to "en".