Merge pull request #877 from Adyen/develop

Release 10.3.0

.github/CODEOWNERS

@@ -1 +1 @@
-* @zaiddreakh @maassenbas @AlexandrosMor @peterojo @wboereboom
+* @zaiddreakh @maassenbas @AlexandrosMor @peterojo @wboereboom @michaelpaul

README.md

@@ -1,6 +1,6 @@
 # Adyen Node.js API Library
 ![Node.js CI](https://github.com/Adyen/adyen-node-api-library/workflows/Node.js%20CI/badge.svg)
-[![Coverage Status](https://coveralls.io/repos/github/Adyen/adyen-node-api-library/badge.svg?branch=master)](https://coveralls.io/github/Adyen/adyen-node-api-library?branch=master)
+[![Coverage Status](https://coveralls.io/repos/github/Adyen/adyen-node-api-library/badge.svg?branch=main)](https://coveralls.io/github/Adyen/adyen-node-api-library?branch=main)
 [![Downloads](https://img.shields.io/npm/dm/@adyen/api-library.svg)](https://www.npmjs.com/package/@adyen/api-library)
 ![npm bundle size (scoped)](https://img.shields.io/bundlephobia/minzip/@adyen/api-library.svg)
 [![Version](https://img.shields.io/npm/v/@adyen/api-library.svg)](https://www.npmjs.com/package/@adyen/api-library)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adyen/api-library",
-  "version": "10.1.0",
+  "version": "10.3.0",
   "description": "The Adyen API Library for NodeJS enables you to work with Adyen APIs.",
   "main": "lib/src/index.js",
   "types": "lib/src/index.d.ts",
@@ -35,28 +35,28 @@
   "author": "Ricardo Ambrogi",
   "license": "MIT",
   "devDependencies": {
-    "@types/jest": "27.0.2",
+    "@types/jest": "27.4.1",
     "@types/nock": "11.1.0",
     "@typescript-eslint/eslint-plugin": "4.33.0",
     "@typescript-eslint/parser": "4.33.0",
     "acorn": "^8.0.1",
     "coveralls": "3.1.1",
-    "dotenv": "^10.0.0",
+    "dotenv": "^16.0.0",
     "eslint": "7.32.0",
     "jest": "^27.0.6",
     "jest-ts-auto-mock": "^2.0.0",
     "kind-of": "^6.0.3",
     "minimist": ">=1.2.3",
-    "nock": "13.2.0",
-    "release-it": "14.11.6",
+    "nock": "13.2.4",
+    "release-it": "14.14.2",
     "ts-auto-mock": "^3.3.5",
     "ts-jest": "^27.0.4",
     "ts-loader": "8.0.10",
     "ttypescript": "^1.5.10",
-    "typescript": "4.4.4"
+    "typescript": "4.6.3"
   },
   "dependencies": {
-    "https-proxy-agent": "5.0.0"
+    "https-proxy-agent": "5.0.1"
   },
   "optionalDependencies": {
     "@types/node": "14.0.9"

src/__mocks__/recurring/listRecurringDetailsSuccess.ts

@@ -18,54 +18,64 @@
  */
 
 export const listRecurringDetailsSuccess = {
-    creationDate: "2017-03-01T10:53:11.000",
-    details: [
+    "creationDate": "2017-03-01T11:53:11+01:00",
+    "details": [
         {
-            additionalData: {
-                cardBin: "411111",
-            },
-            alias: "cardAlias",
-            aliasType: "Default",
-            card: {
-                expiryMonth: "8",
-                expiryYear: "2018",
-                holderName: "Holder",
-                number: "1111",
-            },
-            contractTypes: [
-                "ONECLICK",
-            ],
-            creationDate: "2017-03-01T10:53:11.000",
-            firstPspReference: "8524888762135795",
-            paymentMethodVariant: "visa",
-            recurringDetailReference: "recurringReference",
-            variant: "visa",
-        },
-        {
-            billingAddress: {
-                city: "City",
-                country: "NL",
-                houseNumberOrName: "1",
-                postalCode: "2312aa",
-                stateOrProvince: "NA",
-                street: "Street",
-            },
-            contractTypes: [
-                "RECURRING",
-            ],
-            creationDate: "2017-03-01T10:53:11.000",
-            firstPspReference: "8515076181707110",
-            paymentMethodVariant: "paypal",
-            recurringDetailReference: "8315076181982020",
-            tokenDetails: {
-                tokenData: {
-                    "BillingAgreementId": "B-7MA42752FE774625C",
-                    "EmailId": "tedtest@test.nl",
-                    "PayPal.PayerId": "H95EPL8B2KFE6",
+            "RecurringDetail": {
+                "acquirer": "TestPmmAcquirer",
+                "acquirerAccount": "TestPmmAcquirerAccount",
+                "additionalData": {
+                    "cardBin": "411111"
                 },
-                tokenDataType: "PayPal",
-            },
-            variant: "paypal",
+                "alias": "cardAlias",
+                "aliasType": "Default",
+                "card": {
+                    "expiryMonth": "8",
+                    "expiryYear": "2018",
+                    "holderName": "Holder",
+                    "number": "1111"
+                },
+                "contractTypes": [
+                    "ONECLICK"
+                ],
+                "creationDate": "2017-03-07T09:43:33+01:00",
+                "firstPspReference": "8524888762135795",
+                "paymentMethodVariant": "visa",
+                "recurringDetailReference": "recurringReference",
+                "variant": "visa"
+            }
         },
+        {
+            "RecurringDetail": {
+                "acquirer": "PayPalSandbox",
+                "acquirerAccount": "TestPmmAcquirerAccount",
+                "billingAddress": {
+                    "city": "City",
+                    "country": "NL",
+                    "houseNumberOrName": "1",
+                    "postalCode": "2312aa",
+                    "stateOrProvince": "NA",
+                    "street": "Street"
+                },
+                "contractTypes": [
+                    "RECURRING"
+                ],
+                "creationDate": "2017-10-10T08:50:02+02:00",
+                "firstPspReference": "8515076181707110",
+                "paymentMethodVariant": "paypal",
+                "recurringDetailReference": "8315076181982020",
+                "tokenDetails": {
+                    "tokenData": {
+                        "EmailId": "tedtest@test.nl",
+                        "PayPal.PayerId": "H95EPL8B2KFE6",
+                        "BillingAgreementId": "B-7MA42752FE774625C"
+                    },
+                    "tokenDataType": "PayPal"
+                },
+                "variant": "paypal"
+            }
+        }
     ],
+    "shopperReference": "test-123",
+    "invalidOneclickContracts": "false"
 };

src/__mocks__/terminalApi/sync.ts

@@ -365,3 +365,24 @@ export const syncRefund = {
         }
     }
 };
+
+export const syncResEventNotification = {
+    SaleToPOIRequest: {
+        EventNotification: {
+            EventToNotify: "Reject",
+            EventDetails: "message=Did+not+receive+a+response+from+the+POI.",
+            RejectedMessage: "ewoi...0KfQo=",
+            TimeStamp: "2020-03-31T10:28:39.515Z"
+        },
+        MessageHeader: {
+            DeviceID: "666568147",
+            MessageCategory: "Event",
+            MessageClass: "Event",
+            MessageType: "Notification",
+            POIID: "P400Plus-123456789",
+            ProtocolVersion: "3.0",
+            SaleID: "saleid-4c32759faaa7",
+            ServiceID: "31122609"
+        }
+    }
+};

src/__tests__/platforms.spec.ts

@@ -115,6 +115,7 @@ describe("Platforms Test", function () {
                 ["suspendAccountHolder", createMock<A.SuspendAccountHolderRequest>(), createMock<A.SuspendAccountHolderResponse>()],
                 ["unSuspendAccountHolder", createMock<A.UnSuspendAccountHolderRequest>(), createMock<A.UnSuspendAccountHolderResponse>()],
                 ["closeAccountHolder", createMock<A.CloseAccountHolderRequest>(), createMock<A.CloseAccountResponse>()],
+                ["getTaxForm", createMock<A.GetTaxFormRequest>(), createMock<A.GetTaxFormResponse>()],
             ];
             test.each(cases)(
                 "should %p",
@@ -399,7 +400,19 @@ describe.skip("Platforms Test E2E", function(): void {
                 }
             });
 
-
+            it("should get tax form", async function() {
+              nock.restore();
+              try {
+                const result = await platforms.Account.getTaxForm({
+                    accountHolderCode: accountHolder.accountHolderCode,
+                    formType: "1099-K",
+                    year: 2020
+                });
+                expect(result.content).toBeDefined();
+              } catch (e: any) {
+                assertError(e);
+              }
+            });
         });
     });
     describe("Fund", function () {
@@ -527,4 +540,4 @@ describe.skip("Platforms Test E2E", function(): void {
         });
 
     });
-});
+});

src/__tests__/recurring.spec.ts

@@ -66,18 +66,15 @@ afterEach(() => {
 });
 
 describe("Recurring", (): void => {
-    test.each([false, true])("should test have recurring details list, isMock: %p", async (isMock): Promise<void> => {
-        !isMock && nock.restore();
+    test("should list recurring details ", async (): Promise<void> => {
         scope.post("/listRecurringDetails")
             .reply(200, listRecurringDetailsSuccess);
-
         const request = createRecurringDetailsRequest();
-        try {
-            const result = await recurring.listRecurringDetails(request);
-            expect(result).toBeTruthy();
-        } catch (e: any) {
-            fail(e.message);
-        }
+        
+        const result = await recurring.listRecurringDetails(request);
+        
+        expect(result).toBeTruthy();
+        expect(result.details?.[0].RecurringDetail.recurringDetailReference).toBe('recurringReference');
     });
 
     test.each([isCI, true])("should disable, isMock: %p", async (isMock): Promise<void> => {

src/__tests__/terminalCloudAPI.spec.ts

@@ -12,7 +12,7 @@
  *                               #############
  *                               ############
  * Adyen NodeJS API Library
- * Copyright (c) 2021 Adyen B.V.
+ * Copyright (c) 2022 Adyen N.V.
  * This file is open source and available under the MIT license.
  * See the LICENSE file for more info.
  */
@@ -20,7 +20,7 @@
 import nock from "nock";
 import { createClient, createTerminalAPIPaymentRequest, createTerminalAPIRefundRequest } from "../__mocks__/base";
 import { asyncRes } from "../__mocks__/terminalApi/async";
-import { syncRefund, syncRes } from "../__mocks__/terminalApi/sync";
+import { syncRefund, syncRes, syncResEventNotification } from "../__mocks__/terminalApi/sync";
 import Client from "../client";
 import TerminalCloudAPI from "../services/terminalCloudAPI";
 import { TerminalApiResponse } from "../typings/terminal/models";
@@ -68,6 +68,17 @@ describe("Terminal Cloud API", (): void => {
         expect(terminalAPIResponse.SaleToPOIResponse?.MessageHeader).toBeDefined();
     });
 
+    test.each([isCI, true])("should return event notification if response contains it, isMock: %p", async (isMock): Promise<void> => {
+        !isMock && nock.restore();
+
+        const terminalAPIPaymentRequest = createTerminalAPIPaymentRequest();
+        scope.post("/sync").reply(200, syncResEventNotification);
+
+        const terminalAPIResponse = await terminalCloudAPI.sync(terminalAPIPaymentRequest);
+
+        expect(terminalAPIResponse.SaleToPOIRequest?.EventNotification).toBeDefined();
+    });
+
     test.each([isCI, true])("should make an async refund request, isMock: %p", async (isMock): Promise<void> => {
         !isMock && nock.restore();
         scope.post("/sync").reply(200, syncRes);

src/services/platforms.ts

@@ -53,7 +53,9 @@ import {
     DeleteShareholderRequest,
     PerformVerificationRequest,
     UpdateAccountHolderStateRequest,
-    GetAccountHolderStatusResponse
+    GetAccountHolderStatusResponse,
+    GetTaxFormRequest,
+    GetTaxFormResponse,
 } from "../typings/platformsAccount/models";
 
 type AccountType = AccountTypesEnum.Accounts;
@@ -86,6 +88,7 @@ class Platforms extends Service {
     private readonly _suspendAccountHolder: PlatformsAccount<AccountHoldersType>;
     private readonly _unSuspendAccountHolder: PlatformsAccount<AccountHoldersType>;
     private readonly _closeAccountHolder: PlatformsAccount<AccountHoldersType>;
+    private readonly _getTaxForm: PlatformsAccount<AccountHoldersType>;
 
     /* PlatformsFund */
     private readonly _accountHolderBalance: PlatformsFund;
@@ -128,6 +131,7 @@ class Platforms extends Service {
         this._suspendAccountHolder = new PlatformsAccount<AccountHoldersType>(this, "/suspendAccountHolder");
         this._unSuspendAccountHolder = new PlatformsAccount<AccountHoldersType>(this, "/unSuspendAccountHolder");
         this._closeAccountHolder = new PlatformsAccount<AccountHoldersType>(this, "/closeAccountHolder");
+        this._getTaxForm = new PlatformsAccount<AccountHoldersType>(this, "/getTaxForm");
 
         // Fund
         this._accountHolderBalance = new PlatformsFund(this, "/accountHolderBalance");
@@ -171,6 +175,7 @@ class Platforms extends Service {
         deleteShareholders: (request: DeleteShareholderRequest) => Promise<GenericResponse>;
         checkAccountHolder: (request: PerformVerificationRequest) => Promise<GenericResponse>;
         updateAccountHolderState: (request: UpdateAccountHolderStateRequest) => Promise<GetAccountHolderStatusResponse>;
+        getTaxForm: (request: GetTaxFormRequest) => Promise<GetTaxFormResponse>;
     } {
         const closeAccount = this.createRequest<AccountsAccount, CloseAccountRequest, CloseAccountResponse>(this._closeAccount);
         const updateAccount = this.createRequest<AccountsAccount, UpdateAccountRequest, UpdateAccountResponse>(this._updateAccount);
@@ -190,10 +195,11 @@ class Platforms extends Service {
         const unSuspendAccountHolder = this.createRequest<AccountsAccountHolders, UnSuspendAccountHolderRequest, UnSuspendAccountHolderResponse>(this._unSuspendAccountHolder);
         const closeAccountHolder = this.createRequest<AccountsAccountHolders, CloseAccountHolderRequest, CloseAccountHolderResponse>(this._closeAccountHolder);
         const checkAccountHolder = this.createRequest<AccountsVerification, PerformVerificationRequest, GenericResponse>(this._checkAccountHolder);
+        const getTaxForm = this.createRequest<AccountsAccountHolders, GetTaxFormRequest, GetTaxFormResponse>(this._getTaxForm);
 
         const accounts = { closeAccount, updateAccount, createAccount };
         const verification = { uploadDocument, getUploadedDocuments, deleteBankAccounts, deletePayoutMethods, deleteShareholders, checkAccountHolder };
-        const accountHolders = { createAccountHolder, getAccountHolder, updateAccountHolder, updateAccountHolderState, suspendAccountHolder, unSuspendAccountHolder, closeAccountHolder};
+        const accountHolders = { createAccountHolder, getAccountHolder, updateAccountHolder, updateAccountHolderState, suspendAccountHolder, unSuspendAccountHolder, closeAccountHolder, getTaxForm};
 
         return {...accounts, ...verification, ...accountHolders };
     }

src/services/resource/platforms/account.ts

@@ -30,7 +30,8 @@ type AccountHoldersEndpoints =
     "/updateAccountHolderState"|
     "/suspendAccountHolder"|
     "/unSuspendAccountHolder"|
-    "/closeAccountHolder";
+    "/closeAccountHolder"|
+    "/getTaxForm";
 
 type VerificationEndpoints =
     "/uploadDocument"|

src/typings/recurring/models.ts

@@ -33,6 +33,7 @@ export * from './recurringDetailsResult';
 export * from './scheduleAccountUpdaterRequest';
 export * from './scheduleAccountUpdaterResult';
 export * from './serviceError';
+export * from './recurringDetailContainer';
 
 import * as fs from 'fs';
 import {Address} from './address';
@@ -51,6 +52,7 @@ import {RecurringDetailsResult} from './recurringDetailsResult';
 import {ScheduleAccountUpdaterRequest} from './scheduleAccountUpdaterRequest';
 import {ScheduleAccountUpdaterResult} from './scheduleAccountUpdaterResult';
 import {ServiceError} from './serviceError';
+import {RecurringDetailContainer} from "./recurringDetailContainer";
 
 export interface RequestDetailedFile {
     value: Buffer;
@@ -94,6 +96,7 @@ let typeMap: {[index: string]: any} = {
     "RecurringDetail": RecurringDetail,
     "RecurringDetailsRequest": RecurringDetailsRequest,
     "RecurringDetailsResult": RecurringDetailsResult,
+    'RecurringDetailContainer': RecurringDetailContainer,
     "ScheduleAccountUpdaterRequest": ScheduleAccountUpdaterRequest,
     "ScheduleAccountUpdaterResult": ScheduleAccountUpdaterResult,
     "ServiceError": ServiceError,

src/typings/recurring/recurringDetailContainer.ts

@@ -0,0 +1,32 @@
+/**
+ * Adyen Recurring API
+ * The Recurring APIs allow you to manage and remove your tokens or saved payment details. Tokens should be created with validation during a payment request.  For more information, refer to our [Tokenization documentation](https://docs.adyen.com/online-payments/tokenization). ## Authentication To connect to the Recurring API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/development-resources/api-credentials). Then use its credentials to authenticate your request, for example:  ``` curl -U \"ws@Company.YourCompany\":\"YourWsPassword\" \\ -H \"Content-Type: application/json\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).  ## Versioning Recurring API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.  For example: ``` https://pal-test.adyen.com/pal/servlet/Recurring/v49/disable ```
+ *
+ * The version of the OpenAPI document: 49
+ * Contact: developer-experience@adyen.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import {RecurringDetail} from "./recurringDetail";
+
+export class RecurringDetailContainer {
+    'RecurringDetail': RecurringDetail;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "RecurringDetail",
+            "baseName": "RecurringDetail",
+            "type": "RecurringDetail"
+        }
+    ];
+
+    static getAttributeTypeMap() {
+        return RecurringDetail.attributeTypeMap;
+    }
+}
+

src/typings/recurring/recurringDetailsResult.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 
-import {RecurringDetail} from './recurringDetail';
+import {RecurringDetailContainer} from './recurringDetailContainer';
 
 export class RecurringDetailsResult {
     /**
@@ -20,7 +20,7 @@ export class RecurringDetailsResult {
     /**
     * Payment details stored for recurring payments.
     */
-    'details'?: Array<RecurringDetail>;
+    'details'?: Array<RecurringDetailContainer>;
     /**
     * The most recent email for this shopper (if available).
     */
@@ -41,7 +41,7 @@ export class RecurringDetailsResult {
         {
             "name": "details",
             "baseName": "details",
-            "type": "Array<RecurringDetail>"
+            "type": "Array<RecurringDetailContainer>"
         },
         {
             "name": "lastKnownShopperEmail",

src/typings/terminal/cardData.ts

@@ -12,7 +12,7 @@
  *                               #############
  *                               ############
  * Adyen NodeJS API Library
- * Copyright (c) 2021 Adyen B.V.
+ * Copyright (c) 2022 Adyen N.V.
  * This file is open source and available under the MIT license.
  * See the LICENSE file for more info.
  */
@@ -42,7 +42,7 @@ export class CardData {
     'CardCountryCode'?: string;
     'CustomerOrder'?: Array<CustomerOrder>;
     'EntryMode'?: Array<CardData.EntryModeEnum>;
-    'MaskedPAN'?: string;
+    'MaskedPan'?: string;
     'PaymentAccountRef'?: string;
     'PaymentBrand'?: string;
     'PaymentToken'?: PaymentToken;
@@ -78,8 +78,8 @@ export class CardData {
             "type": "Array<CardData.EntryModeEnum>"
         },
         {
-            "name": "MaskedPAN",
-            "baseName": "MaskedPAN",
+            "name": "MaskedPan",
+            "baseName": "MaskedPan",
             "type": "string"
         },
         {

src/typings/terminal/terminalApiResponse.ts

@@ -12,28 +12,24 @@
  *                               #############
  *                               ############
  * Adyen NodeJS API Library
- * Copyright (c) 2021 Adyen B.V.
+ * Copyright (c) 2022 Adyen N.V.
  * This file is open source and available under the MIT license.
  * See the LICENSE file for more info.
  */
- 
+
 /**
  * Terminal API
  * Definition of Terminal API Schema
  *
- * The version of the OpenAPI document: 1.0.0
- * 
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
  */
 
 
 import { SaleToPOIResponse } from './saleToPOIResponse';
+import {SaleToPOIRequest} from "./saleToPOIRequest";
 
 export class TerminalApiResponse {
     'SaleToPOIResponse'?: SaleToPOIResponse;
+    'SaleToPOIRequest'?: SaleToPOIRequest;
 
     static discriminator: string | undefined = undefined;
 
@@ -42,7 +38,12 @@ export class TerminalApiResponse {
             "name": "SaleToPOIResponse",
             "baseName": "SaleToPOIResponse",
             "type": "SaleToPOIResponse"
-        }    ];
+        },
+        {
+            "name": "SaleToPOIRequest",
+            "baseName": "SaleToPOIRequest",
+            "type": "SaleToPOIRequest"
+        }];
 
     static getAttributeTypeMap() {
         return TerminalApiResponse.attributeTypeMap;