Changes from gocardless/gocardless-nodejs-template

README.md

@@ -22,7 +22,7 @@ To initialise the client, you must provide:
 
 <!-- prettier-ignore -->
 ```js
-const gocardless = require('gocardless-nodejs');
+const gocardless = require('gocardless-nodejs/client');
 const constants = require('gocardless-nodejs/constants');
 
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "gocardless-nodejs",
-  "version": "6.0.0",
+  "version": "7.0.0",
   "description": "Node.js client for the GoCardless API - a powerful, simple solution for the collection of recurring bank-to-bank payments",
   "author": "GoCardless Ltd <client-libraries@gocardless.com>",
   "repository": {
@@ -27,24 +27,24 @@
   "dependencies": {
     "got": "^11.8.6",
     "lodash": "^4.17.21",
-    "uuid": "^9.0.0",
+    "uuid": "^11.1.0",
     "buffer-equal-constant-time": "1.0.1",
-    "qs": "^6.11.1"
+    "qs": "^6.14.0"
   },
   "devDependencies": {
-    "@types/jest": "^29.5.0",
+    "@types/jest": "^30.0.0",
     "@types/node": "^18.15.10",
     "@typescript-eslint/eslint-plugin": "^5.57.0",
     "@typescript-eslint/parser": "^5.57.0",
     "eslint": "^8.37.0",
     "eslint-config-prettier": "^8.8.0",
     "eslint-plugin-prettier": "^4.2.1",
-    "jest": "^29.5.0",
+    "jest": "^30.1.3",
     "nock": "^13.3.0",
     "prettier": "^2.8.7",
     "prettier-eslint": "^15.0.1",
     "prettier-eslint-cli": "^7.1.0",
-    "ts-jest": "29.0.5",
+    "ts-jest": "29.4.1",
     "typescript": "^5.0.2"
   },
   "main": "index.js",

src/api/api.ts

@@ -5,7 +5,7 @@ import process = require('process');
 import _ = require('lodash');
 import { v4 as uuidv4 } from 'uuid';
 import * as url from 'url';
-import got, { OptionsOfJSONResponseBody } from 'got';
+import got, { Agents, OptionsOfJSONResponseBody } from 'got';
 import qs from 'qs';
 
 import { Environments, CLIENT_VERSION, API_VERSION } from '../constants';
@@ -17,7 +17,7 @@ import {
 } from '../apiRequestSigning';
 
 export interface APIOptions {
-  proxy?: object;
+  proxy?: Agents;
   raiseOnIdempotencyConflict?: boolean;
   apiRequestSigningOptions?: ApiRequestSigningOptions;
 }
@@ -42,7 +42,7 @@ export class Api {
   private _token: string;
   private _environment: Environments;
   private _baseUrl: string;
-  private _agent: object;
+  private _agent: Agents | undefined;
   private raiseOnIdempotencyConflict: boolean;
   private apiRequestSigningOptions: ApiRequestSigningOptionsInternal | null = null;
 

src/client.ts

@@ -4,6 +4,7 @@ import { Environments } from './constants';
 import { Api, APIOptions } from './api/api';
 import { BalanceService } from './services/balanceService';
 import { BankAccountDetailService } from './services/bankAccountDetailService';
+import { BankAccountHolderVerificationService } from './services/bankAccountHolderVerificationService';
 import { BankAuthorisationService } from './services/bankAuthorisationService';
 import { BankDetailsLookupService } from './services/bankDetailsLookupService';
 import { BillingRequestService } from './services/billingRequestService';
@@ -31,6 +32,8 @@ import { OutboundPaymentService } from './services/outboundPaymentService';
 import { PayerAuthorisationService } from './services/payerAuthorisationService';
 import { PayerThemeService } from './services/payerThemeService';
 import { PaymentService } from './services/paymentService';
+import { PaymentAccountService } from './services/paymentAccountService';
+import { PaymentAccountTransactionService } from './services/paymentAccountTransactionService';
 import { PayoutService } from './services/payoutService';
 import { PayoutItemService } from './services/payoutItemService';
 import { RedirectFlowService } from './services/redirectFlowService';
@@ -48,6 +51,7 @@ export class GoCardlessClient {
 
   private _balances: BalanceService;
   private _bankAccountDetails: BankAccountDetailService;
+  private _bankAccountHolderVerifications: BankAccountHolderVerificationService;
   private _bankAuthorisations: BankAuthorisationService;
   private _bankDetailsLookups: BankDetailsLookupService;
   private _billingRequests: BillingRequestService;
@@ -75,6 +79,8 @@ export class GoCardlessClient {
   private _payerAuthorisations: PayerAuthorisationService;
   private _payerThemes: PayerThemeService;
   private _payments: PaymentService;
+  private _paymentAccounts: PaymentAccountService;
+  private _paymentAccountTransactions: PaymentAccountTransactionService;
   private _payouts: PayoutService;
   private _payoutItems: PayoutItemService;
   private _redirectFlows: RedirectFlowService;
@@ -92,6 +98,7 @@ export class GoCardlessClient {
 
     this._balances = undefined;
     this._bankAccountDetails = undefined;
+    this._bankAccountHolderVerifications = undefined;
     this._bankAuthorisations = undefined;
     this._bankDetailsLookups = undefined;
     this._billingRequests = undefined;
@@ -119,6 +126,8 @@ export class GoCardlessClient {
     this._payerAuthorisations = undefined;
     this._payerThemes = undefined;
     this._payments = undefined;
+    this._paymentAccounts = undefined;
+    this._paymentAccountTransactions = undefined;
     this._payouts = undefined;
     this._payoutItems = undefined;
     this._redirectFlows = undefined;
@@ -148,6 +157,14 @@ export class GoCardlessClient {
     return this._bankAccountDetails;
   }
 
+  get bankAccountHolderVerifications(): BankAccountHolderVerificationService {
+    if (!this._bankAccountHolderVerifications) {
+      this._bankAccountHolderVerifications = new BankAccountHolderVerificationService(this._api);
+    }
+
+    return this._bankAccountHolderVerifications;
+  }
+
   get bankAuthorisations(): BankAuthorisationService {
     if (!this._bankAuthorisations) {
       this._bankAuthorisations = new BankAuthorisationService(this._api);
@@ -364,6 +381,22 @@ export class GoCardlessClient {
     return this._payments;
   }
 
+  get paymentAccounts(): PaymentAccountService {
+    if (!this._paymentAccounts) {
+      this._paymentAccounts = new PaymentAccountService(this._api);
+    }
+
+    return this._paymentAccounts;
+  }
+
+  get paymentAccountTransactions(): PaymentAccountTransactionService {
+    if (!this._paymentAccountTransactions) {
+      this._paymentAccountTransactions = new PaymentAccountTransactionService(this._api);
+    }
+
+    return this._paymentAccountTransactions;
+  }
+
   get payouts(): PayoutService {
     if (!this._payouts) {
       this._payouts = new PayoutService(this._api);

src/constants.ts

@@ -5,7 +5,7 @@ enum Environments {
   Sandbox = 'SANDBOX',
 }
 
-const CLIENT_VERSION = '6.0.0';
+const CLIENT_VERSION = '7.0.0';
 const API_VERSION = '2015-07-06';
 
 export { Environments, CLIENT_VERSION, API_VERSION };

src/services/bankAccountHolderVerificationService.ts

@@ -0,0 +1,80 @@
+'use strict';
+
+import { Api } from '../api/api';
+import * as Types from '../types/Types';
+
+interface BankAccountHolderVerificationResponse extends Types.BankAccountHolderVerification, Types.APIResponse {}
+
+interface BankAccountHolderVerificationListResponse extends Types.APIResponse {
+  bank_account_holder_verifications: Array<Types.BankAccountHolderVerification>;
+  meta: Types.ListMeta;
+}
+
+interface BankAccountHolderVerificationCreateRequest {
+  // Resources linked to this BankAccountHolderVerification.
+  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/)
+
+  type: Types.BankAccountHolderVerificationType;
+}
+
+export class BankAccountHolderVerificationService {
+  private api: Api;
+
+  constructor(api) {
+    this.api = api;
+  }
+
+  public async create(
+    requestParameters: BankAccountHolderVerificationCreateRequest,
+    idempotencyKey = '',
+    customHeaders: Types.JsonMap = {},
+  ): Promise<BankAccountHolderVerificationResponse> {
+    const urlParameters = [];
+    const requestParams = {
+      path: '/bank_account_holder_verifications',
+      method: 'post',
+      urlParameters,
+      requestParameters,
+      payloadKey: 'bank_account_holder_verifications',
+      idempotencyKey,
+      customHeaders,
+      fetch: async (identity) => await this.find(identity),
+    };
+
+    const response = await this.api.request(requestParams);
+    const formattedResponse: BankAccountHolderVerificationResponse = {
+      ...(response.body?.['bank_account_holder_verifications'] ?? response),
+      __response__: response.__response__,
+    };
+
+    return formattedResponse;
+  }
+
+  public async find(
+    identity: string,
+    customHeaders: Types.JsonMap = {},
+  ): Promise<BankAccountHolderVerificationResponse> {
+    const urlParameters = [{ key: 'identity', value: identity }];
+    const requestParams = {
+      path: '/bank_account_holder_verifications/:identity',
+      method: 'get',
+      urlParameters,
+
+      payloadKey: null,
+      fetch: null,
+      customHeaders,
+    };
+
+    const response = await this.api.request(requestParams);
+    const formattedResponse: BankAccountHolderVerificationResponse = {
+      ...response.body['bank_account_holder_verifications'],
+      __response__: response.__response__,
+    };
+
+    return formattedResponse;
+  }
+}

src/services/billingRequestService.ts

@@ -59,9 +59,10 @@ interface BillingRequestCollectCustomerDetailsRequest {
 }
 
 interface BillingRequestCollectBankAccountRequest {
-  // Name of the account holder, as known by the bank. This field will be
-  // transliterated, upcased and truncated to 18 characters. This field is
-  // required unless the request includes a [customer bank account
+  // 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).
 
   account_holder_name?: string;

src/services/billingRequestTemplateService.ts

@@ -22,6 +22,15 @@ interface BillingRequestTemplateListRequest {
   // Number of records to return.
 
   limit?: string;
+
+  // (Optional) A scheme used for Open Banking payments. Currently
+  // `faster_payments` is supported in the UK (GBP) and `sepa_credit_transfer` and
+  // `sepa_instant_credit_transfer` are supported in supported Eurozone countries
+  // (EUR). For Eurozone countries, `sepa_credit_transfer` is used as the default.
+  // Please be aware that `sepa_instant_credit_transfer` may incur an additional
+  // fee for your customer.
+
+  payment_request_scheme?: string;
 }
 
 interface BillingRequestTemplateCreateRequest {

src/services/customerBankAccountService.ts

@@ -11,9 +11,10 @@ interface CustomerBankAccountListResponse extends Types.APIResponse {
 }
 
 interface CustomerBankAccountCreateRequest {
-  // Name of the account holder, as known by the bank. This field will be
-  // transliterated, upcased and truncated to 18 characters. This field is
-  // required unless the request includes a [customer bank account
+  // 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).
 
   account_holder_name?: string;

src/services/instalmentScheduleService.ts

@@ -63,7 +63,7 @@ interface InstalmentScheduleCreateWithDatesRequest {
   payment_reference?: string;
 
   // On failure, automatically retry payments using [intelligent
-  // retries](#success-intelligent-retries). Default is `false`. <p
+  // retries](/success-plus/overview). Default is `false`. <p
   // class="notice"><strong>Important</strong>: To be able to use intelligent
   // retries, Success+ needs to be enabled in [GoCardless
   // dashboard](https://manage.gocardless.com/success-plus). </p>
@@ -135,7 +135,7 @@ interface InstalmentScheduleCreateWithScheduleRequest {
   payment_reference?: string;
 
   // On failure, automatically retry payments using [intelligent
-  // retries](#success-intelligent-retries). Default is `false`. <p
+  // retries](/success-plus/overview). Default is `false`. <p
   // class="notice"><strong>Important</strong>: To be able to use intelligent
   // retries, Success+ needs to be enabled in [GoCardless
   // dashboard](https://manage.gocardless.com/success-plus). </p>

src/services/mandateService.ts

@@ -106,7 +106,7 @@ interface MandateListRequest {
 
   scheme?: string[];
 
-  // At most four valid status values
+  // One or more valid statuses
 
   status?: Types.MandateStatus[];
 }