Changes from gocardless/client-library-templates

package.json

@@ -106,24 +106,24 @@
   },
   "dependencies": {
     "got": "^11.8.6",
-    "uuid": "^14.0.0",
-    "qs": "^6.14.0"
+    "uuid": "^14.0.1",
+    "qs": "^6.15.3"
   },
   "devDependencies": {
     "@types/jest": "^30.0.0",
-    "@types/node": "^18.15.10",
+    "@types/node": "^22.14.1",
     "@typescript-eslint/eslint-plugin": "^5.57.0",
     "@typescript-eslint/parser": "^5.57.0",
-    "eslint": "^8.37.0",
+    "eslint": "^8.57.1",
     "eslint-config-prettier": "^8.8.0",
-    "eslint-plugin-prettier": "^4.2.1",
-    "jest": "^30.1.3",
-    "nock": "^13.3.0",
-    "prettier": "^2.8.7",
+    "eslint-plugin-prettier": "^4.2.5",
+    "jest": "^30.4.2",
+    "nock": "^13.5.6",
+    "prettier": "^2.8.8",
     "prettier-eslint": "^15.0.1",
     "prettier-eslint-cli": "^7.1.0",
-    "ts-jest": "29.4.1",
-    "typescript": "^5.0.2"
+    "ts-jest": "29.4.12",
+    "typescript": "^5.9.3"
   },
   "files": [
     "esm/",

src/codeSamples/customer_notificationsCodeSamples.test.ts

@@ -50,7 +50,7 @@ describe('CustomerNotifications Code Samples', () => {
 
     try {
       /* eslint-disable @typescript-eslint/no-unused-vars */
-      const customerNotification = await client.customerNotifications.handle('PCN123');
+      const customerNotification = await client.customerNotifications.handle('EV1D18JEXAMPLE');
       /* eslint-enable @typescript-eslint/no-unused-vars */
     } finally {
       console.log = originalLog;

src/services/balanceService.ts

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

src/services/bankAccountHolderVerificationService.ts

@@ -13,8 +13,8 @@ interface BankAccountHolderVerificationCreateRequest {
   links: Types.BankAccountHolderVerificationCreateRequestLinks;
 
   // Type of the verification that has been performed
-  // eg. [Confirmation of
-  // Payee](https://www.wearepay.uk/what-we-do/overlay-services/confirmation-of-payee/)
+  // eg. Confirmation of Payee
+  // (https://www.wearepay.uk/what-we-do/overlay-services/confirmation-of-payee/)
 
   type: `${Types.BankAccountHolderVerificationType}`;
 }

src/services/bankAuthorisationService.ts

@@ -24,11 +24,13 @@ 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`](#billing-request-bankauthorisationauthorised),
-  // [`BANK_AUTHORISATION_DENIED`](#billing-request-bankauthorisationdenied), or
-  // [`BANK_AUTHORISATION_FAILED`](#billing-request-bankauthorisationfailed) in
-  // order to show the correct outcome to the user.
+  // bank authorisation event, such as `BANK_AUTHORISATION_AUTHORISED`
+  // (https://developer.gocardless.com/api-reference/#billing-request-bankauthorisationauthorised),
+  // `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.
   //
   // The BillingRequestFlow ID will also be appended to the `redirect_uri` as
   // query parameter `id=BRF123`.

src/services/bankDetailsLookupService.ts

@@ -15,29 +15,33 @@ interface BankDetailsLookupCreateRequest {
 
   account_holder_name?: string;
 
-  // Bank account number - see [local details](#appendix-local-bank-details) for
-  // more information. Alternatively you can provide an `iban`.
+  // 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`.
 
   account_number?: string;
 
-  // Bank code - see [local details](#appendix-local-bank-details) for more
-  // information. Alternatively you can provide an `iban`.
+  // Bank code - see local details
+  // (https://developer.gocardless.com/api-reference/#appendix-local-bank-details)
+  // for more information. Alternatively you can provide an `iban`.
 
   bank_code?: string;
 
-  // Branch code - see [local details](#appendix-local-bank-details) for more
-  // information. Alternatively you can provide an `iban`.
+  // Branch code - see local details
+  // (https://developer.gocardless.com/api-reference/#appendix-local-bank-details)
+  // for more information. Alternatively you can provide an `iban`.
 
   branch_code?: string;
 
-  // [ISO
-  // 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)
+  // ISO 3166-1
+  // (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)
   // alpha-2 code. Must be provided if specifying local details.
 
   country_code?: string;
 
-  // International Bank Account Number. Alternatively you can provide [local
-  // details](#appendix-local-bank-details).
+  // International Bank Account Number. Alternatively you can provide local
+  // details
+  // (https://developer.gocardless.com/api-reference/#appendix-local-bank-details).
 
   iban?: string;
 }

src/services/billingRequestFlowService.ts

@@ -24,8 +24,8 @@ interface BillingRequestFlowCreateRequest {
 
   exit_uri?: string;
 
-  // Sets the default language of the Billing Request Flow and the customer. [ISO
-  // 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) code.
+  // Sets the default language of the Billing Request Flow and the customer. ISO
+  // 639-1 (https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) code.
 
   language?: string;
 
@@ -38,7 +38,6 @@ interface BillingRequestFlowCreateRequest {
   //
   // You can only lock bank account if these have already been completed as a part
   // of the billing request.
-  //
 
   lock_bank_account?: boolean;
 
@@ -55,7 +54,6 @@ interface BillingRequestFlowCreateRequest {
   //
   // You can only lock customer details if these have already been completed as a
   // part of the billing request.
-  //
 
   lock_customer_details?: boolean;
 

src/services/billingRequestService.ts

@@ -13,8 +13,8 @@ interface BillingRequestCreateRequest {
   // direct debit.
   // 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/)
+  // See Billing Requests: Retain customers with Fallbacks
+  // (https://developer.gocardless.com/billing-requests/retain-customers-with-fallbacks/)
   // for more information.
 
   fallback_enabled?: boolean;
@@ -44,9 +44,9 @@ interface BillingRequestCreateRequest {
   // Specifies the underlying purpose of the payment. Defines the specific reason
   // 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.
+  // See VRP Commercial Payment Purpose Codes
+  // (https://developer.gocardless.com/vrp-commercial-payment-purpose-codes/) for
+  // the complete list of valid codes.
 
   payment_purpose_code?: string;
 
@@ -56,9 +56,9 @@ interface BillingRequestCreateRequest {
   // Specifies the high-level purpose/category of a mandate and/or payment using a
   // 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.
+  // See Billing Request Purpose Codes
+  // (https://developer.gocardless.com/billing-request-purpose-codes/) for the
+  // complete list of valid codes.
 
   purpose_code?: `${Types.BillingRequestPurposeCode}`;
 
@@ -78,54 +78,63 @@ interface BillingRequestCollectBankAccountRequest {
   // Name of the account holder, as known by the bank. The full name provided when
   // the customer is created is stored and is available via the API, but is
   // transliterated, upcased, and truncated to 18 characters in bank submissions.
-  // This field is required unless the request includes a [customer bank account
-  // token](#javascript-flow-customer-bank-account-tokens).
+  // 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).
 
   account_holder_name?: string;
 
-  // Bank account number - see [local details](#appendix-local-bank-details) for
-  // more information. Alternatively you can provide an `iban`.
+  // 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`.
 
   account_number?: string;
 
-  // Account number suffix (only for bank accounts denominated in NZD) - see
-  // [local details](#local-bank-details-new-zealand) for more information.
+  // Account number suffix (only for bank accounts denominated in NZD) - see local
+  // details
+  // (https://developer.gocardless.com/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](#local-bank-details-united-states) for more information.
+  // provided for bank accounts in other currencies. See local details
+  // (https://developer.gocardless.com/api-reference/#local-bank-details-united-states)
+  // for more information.
 
   account_type?: `${Types.BillingRequestAccountType}`;
 
-  // Bank code - see [local details](#appendix-local-bank-details) for more
-  // information. Alternatively you can provide an `iban`.
+  // Bank code - see local details
+  // (https://developer.gocardless.com/api-reference/#appendix-local-bank-details)
+  // for more information. Alternatively you can provide an `iban`.
 
   bank_code?: string;
 
-  // Branch code - see [local details](#appendix-local-bank-details) for more
-  // information. Alternatively you can provide an `iban`.
+  // Branch code - see local details
+  // (https://developer.gocardless.com/api-reference/#appendix-local-bank-details)
+  // for more information. Alternatively you can provide an `iban`.
 
   branch_code?: string;
 
-  // [ISO 3166-1 alpha-2
-  // code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements).
+  // ISO 3166-1 alpha-2 code
+  // (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements).
   // Defaults to the country code of the `iban` if supplied, otherwise is
   // required.
 
   country_code?: string;
 
-  // [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency
-  // code. Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are
+  // ISO 4217 (https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code.
+  // Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are
   // supported.
 
   currency?: string;
 
-  // International Bank Account Number. Alternatively you can provide [local
-  // details](#appendix-local-bank-details). IBANs are not accepted for Swedish
-  // bank accounts denominated in SEK - you must supply [local
-  // details](#local-bank-details-sweden).
+  // International Bank Account Number. Alternatively you can provide local
+  // details
+  // (https://developer.gocardless.com/api-reference/#appendix-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).
 
   iban?: string;
 
@@ -182,8 +191,9 @@ interface BillingRequestListRequest {
   // The creation date of this BillingRequest.
   created_at?: Types.CreatedAtFilter;
 
-  // ID of a [customer](#core-endpoints-customers). If specified, this endpoint
-  // will return all requests for the given customer.
+  // ID of a customer
+  // (https://developer.gocardless.com/api-reference/#core-endpoints-customers).
+  // If specified, this endpoint will return all requests for the given customer.
 
   customer?: string;
 
@@ -192,15 +202,12 @@ interface BillingRequestListRequest {
   limit?: string;
 
   // One of:
-  // <ul>
-  // <li>`pending`: the billing request is pending and can be used</li>
-  // <li>`ready_to_fulfil`: the billing request is ready to fulfil</li>
-  // <li>`fulfilling`: the billing request is currently undergoing fulfilment</li>
-  // <li>`fulfilled`: the billing request has been fulfilled and a payment
-  // created</li>
-  // <li>`cancelled`: the billing request has been cancelled and cannot be
-  // used</li>
-  // </ul>
+  //
+  // - `pending`: the billing request is pending and can be used
+  // - `ready_to_fulfil`: the billing request is ready to fulfil
+  // - `fulfilling`: the billing request is currently undergoing fulfilment
+  // - `fulfilled`: the billing request has been fulfilled and a payment created
+  // - `cancelled`: the billing request has been cancelled and cannot be used
 
   status?: `${Types.BillingRequestStatus}`;
 }
@@ -216,8 +223,8 @@ interface BillingRequestNotifyRequest {
 }
 
 interface BillingRequestChooseCurrencyRequest {
-  // [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency
-  // code. Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are
+  // ISO 4217 (https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code.
+  // Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are
   // supported.
 
   currency: string;
@@ -229,8 +236,8 @@ interface BillingRequestChooseCurrencyRequest {
 }
 
 interface BillingRequestSelectInstitutionRequest {
-  // [ISO
-  // 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)
+  // ISO 3166-1
+  // (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)
   // alpha-2 code. The country code of the institution. If nothing is provided,
   // institutions with the country code 'GB' are returned by default.