Merge pull request #1510 from Adyen/generate-apis-models

OpenAPI v7 Generation: Classic Payments, BalanceControl, Disputes, StoredValue

Author: gcatanese

src/__tests__/balanceControl.spec.ts

@@ -44,7 +44,7 @@ describe("Balance Control", (): void => {
         scope.post("/balanceTransfer")
             .reply(200, expected);
 
-        const response: BalanceTransferResponse = await balanceService.balanceTransfer(request);
+        const response: BalanceTransferResponse = await balanceService.BalanceControlApi.balanceTransfer(request);
         expect(response.status).toEqual(BalanceTransferResponse.StatusEnum.Transferred);
     });
 
@@ -61,7 +61,7 @@ describe("Balance Control", (): void => {
             scope.post("/balanceTransfer")
                 .reply(422, expected);
 
-            await balanceService.balanceTransfer(request);
+            await balanceService.BalanceControlApi.balanceTransfer(request);
             fail("No exception was thrown");
         } catch (error) {
             expect(error instanceof HttpClientException).toBeTruthy();
@@ -73,7 +73,7 @@ describe("Balance Control", (): void => {
                 expect(error.apiError).toBeTruthy();
                 expect(error.apiError?.errorCode).toBe("30_004");
                 expect(error.apiError?.message).toBe("Merchant account code is invalid or missing");
-                expect(error.apiError?.errorType).toBe("validation")
+                expect(error.apiError?.errorType).toBe("validation");
             } else {
                 fail("Error did not contain the expected data");
             }

src/__tests__/classicIntegration.spec.ts

@@ -1,13 +1,13 @@
 import nock from "nock";
 import {createClient} from "../__mocks__/base";
 import Client from "../client";
-import ClassicIntegration from "../services/paymentApi";
+import { PaymentAPI } from "../services";
 import { payment } from "../typings";
 import HttpClientException from "../httpClient/httpClientException";
 import {PaymentResult} from "../typings/payment/paymentResult";
 
 let client: Client;
-let classicIntegration: ClassicIntegration;
+let classicIntegration: PaymentAPI;
 let scope: nock.Scope;
 
 beforeEach((): void => {
@@ -16,7 +16,7 @@ beforeEach((): void => {
     }
     client = createClient();
     scope = nock("https://pal-test.adyen.com/pal/servlet/Payment/v68");
-    classicIntegration = new ClassicIntegration(client);
+    classicIntegration = new PaymentAPI(client);
 });
 
 afterEach(() => {
@@ -52,7 +52,7 @@ describe("Classic Integration", (): void => {
               "merchantAccount": "YOUR_MERCHANT_ACCOUNT"
         };
 
-        const paymentResult: PaymentResult = await classicIntegration.authorise(paymentRequest);
+        const paymentResult: PaymentResult = await classicIntegration.PaymentsApi.authorise(paymentRequest);
         expect(paymentResult.pspReference).toEqual("JVBXGSDM53RZNN82");
     });
 
@@ -82,7 +82,7 @@ describe("Classic Integration", (): void => {
                 "merchantAccount": "INVALID_MERCHANT_ACCOUNT"
             };
 
-           await classicIntegration.authorise(paymentRequest);
+           await classicIntegration.PaymentsApi.authorise(paymentRequest);
         } catch (error) {
             expect(error instanceof HttpClientException).toBeTruthy();
             if(error instanceof HttpClientException && error.responseBody && error.stack) {
@@ -112,7 +112,7 @@ describe("Classic Integration", (): void => {
             "merchantAccount": "YOUR_MERCHANT_ACCOUNT"
           };
 
-        const paymentResult: payment.PaymentResult = await classicIntegration.authorise3d(paymentRequest);
+        const paymentResult: payment.PaymentResult = await classicIntegration.PaymentsApi.authorise3d(paymentRequest);
         expect(paymentResult.pspReference).toEqual("JVBXGSDM53RZNN82");
     });
 
@@ -142,7 +142,7 @@ describe("Classic Integration", (): void => {
             "threeDS2Token": "— - BINARY DATA - -"
           };
 
-        const paymentResult: payment.PaymentResult = await classicIntegration.authorise3ds2(paymentRequest);
+        const paymentResult: payment.PaymentResult = await classicIntegration.PaymentsApi.authorise3ds2(paymentRequest);
         expect(paymentResult.pspReference).toEqual("JVBXGSDM53RZNN82");
     });
 
@@ -156,7 +156,7 @@ describe("Classic Integration", (): void => {
             "pspReference": "9935272408535455"
         };
 
-        const getAuthenticationResultResponse: payment.AuthenticationResultResponse = await classicIntegration.getAuthenticationResult(getAuthenticationResultrequest);
+        const getAuthenticationResultResponse: payment.AuthenticationResultResponse = await classicIntegration.PaymentsApi.getAuthenticationResult(getAuthenticationResultrequest);
         expect(getAuthenticationResultResponse?.threeDS2Result?.authenticationValue).toEqual("THREEDS2RESULT");
     });
 
@@ -169,7 +169,7 @@ describe("Classic Integration", (): void => {
             "pspReference": "9935272408535455"
           };
 
-        const retrieve3ds2ResultResponse: payment.ThreeDS2ResultResponse = await classicIntegration.retrieve3ds2Result(retrieve3ds2ResultRequest);
+        const retrieve3ds2ResultResponse: payment.ThreeDS2ResultResponse = await classicIntegration.PaymentsApi.retrieve3ds2Result(retrieve3ds2ResultRequest);
         expect(retrieve3ds2ResultResponse?.threeDS2Result?.authenticationValue).toEqual("THREEDS2RESULT");
     });
 
@@ -190,7 +190,7 @@ describe("Classic Integration", (): void => {
             "merchantAccount": "YOUR_MERCHANT_ACCOUNT"
           };
 
-          const modificationResult: payment.ModificationResult = await classicIntegration.capture(modificationRequest);
+          const modificationResult: payment.ModificationResult = await classicIntegration.ModificationsApi.capture(modificationRequest);
           expect(modificationResult.response).toEqual(payment.ModificationResult.ResponseEnum.CaptureReceived);
     });
 
@@ -207,7 +207,7 @@ describe("Classic Integration", (): void => {
             "merchantAccount": "YOUR_MERCHANT_ACCOUNT"
           };
 
-          const modificationResult: payment.ModificationResult = await classicIntegration.cancel(modificationRequest);
+          const modificationResult: payment.ModificationResult = await classicIntegration.ModificationsApi.cancel(modificationRequest);
           expect(modificationResult.response).toEqual(payment.ModificationResult.ResponseEnum.CancelReceived);
     });
 
@@ -228,7 +228,7 @@ describe("Classic Integration", (): void => {
             "merchantAccount": "YOUR_MERCHANT_ACCOUNT"
           };
 
-          const modificationResult: payment.ModificationResult = await classicIntegration.refund(modificationRequest);
+          const modificationResult: payment.ModificationResult = await classicIntegration.ModificationsApi.refund(modificationRequest);
           expect(modificationResult.response).toEqual(payment.ModificationResult.ResponseEnum.RefundReceived);
     });
 
@@ -245,7 +245,7 @@ describe("Classic Integration", (): void => {
             "merchantAccount": "YOUR_MERCHANT_ACCOUNT"
           };
 
-          const modificationResult: payment.ModificationResult = await classicIntegration.cancelOrRefund(modificationRequest);
+          const modificationResult: payment.ModificationResult = await classicIntegration.ModificationsApi.cancelOrRefund(modificationRequest);
           expect(modificationResult.response).toEqual(payment.ModificationResult.ResponseEnum.CancelOrRefundReceived);
     });
 
@@ -266,7 +266,7 @@ describe("Classic Integration", (): void => {
             "merchantAccount": "YOUR_MERCHANT_ACCOUNT"
           };
 
-          const modificationResult: payment.ModificationResult = await classicIntegration.technicalCancel(modificationRequest);
+          const modificationResult: payment.ModificationResult = await classicIntegration.ModificationsApi.technicalCancel(modificationRequest);
           expect(modificationResult.response).toEqual(payment.ModificationResult.ResponseEnum.TechnicalCancelReceived);
     });
 
@@ -287,7 +287,7 @@ describe("Classic Integration", (): void => {
             "merchantAccount": "YOUR_MERCHANT_ACCOUNT"
           };
 
-          const modificationResult: payment.ModificationResult = await classicIntegration.adjustAuthorisation(modificationRequest);
+          const modificationResult: payment.ModificationResult = await classicIntegration.ModificationsApi.adjustAuthorisation(modificationRequest);
           expect(modificationResult.response).toEqual(payment.ModificationResult.ResponseEnum.AdjustAuthorisationReceived);
     });
 
@@ -309,7 +309,7 @@ describe("Classic Integration", (): void => {
             "merchantAccount": "YOUR_MERCHANT_ACCOUNT"
           };
 
-          const modificationResult: payment.ModificationResult = await classicIntegration.donate(modificationRequest);
+          const modificationResult: payment.ModificationResult = await classicIntegration.ModificationsApi.donate(modificationRequest);
           expect(modificationResult.response).toEqual(payment.ModificationResult.ResponseEnum.DonationReceived);
     });
 
@@ -326,7 +326,7 @@ describe("Classic Integration", (): void => {
             "uniqueTerminalId": "VX820-123456789"
           };
 
-          const modificationResult: payment.ModificationResult = await classicIntegration.voidPendingRefund(modificationRequest);
+          const modificationResult: payment.ModificationResult = await classicIntegration.ModificationsApi.voidPendingRefund(modificationRequest);
           expect(modificationResult.response).toEqual(payment.ModificationResult.ResponseEnum.VoidPendingRefundReceived);
     });
 });

src/__tests__/disputes.spec.ts

@@ -42,7 +42,7 @@ describe("Disputes", (): void => {
         scope.post("/acceptDispute")
             .reply(200, expected);
 
-        const response: AcceptDisputeResponse = await disputesService.acceptDispute(request);
+        const response: AcceptDisputeResponse = await disputesService.DisputesApi.acceptDispute(request);
         expect(response.disputeServiceResult.success).toEqual(true);
     });
 
@@ -57,7 +57,7 @@ describe("Disputes", (): void => {
         scope.post("/defendDispute")
             .reply(200, expected);
 
-        const response: DefendDisputeResponse = await disputesService.defendDispute(request);
+        const response: DefendDisputeResponse = await disputesService.DisputesApi.defendDispute(request);
         expect(response.disputeServiceResult.success).toEqual(true);
     });
 
@@ -72,7 +72,7 @@ describe("Disputes", (): void => {
         scope.post("/deleteDisputeDefenseDocument")
             .reply(200, expected);
 
-        const response: DeleteDefenseDocumentResponse = await disputesService.deleteDisputeDefenseDocument(request);
+        const response: DeleteDefenseDocumentResponse = await disputesService.DisputesApi.deleteDisputeDefenseDocument(request);
         expect(response.disputeServiceResult.success).toEqual(true);
     });
 
@@ -87,7 +87,7 @@ describe("Disputes", (): void => {
         scope.post("/deleteDisputeDefenseDocument")
             .reply(200, expected);
 
-        const response: DeleteDefenseDocumentResponse = await disputesService.deleteDisputeDefenseDocument(request);
+        const response: DeleteDefenseDocumentResponse = await disputesService.DisputesApi.deleteDisputeDefenseDocument(request);
         expect(response.disputeServiceResult.success).toEqual(true);
     });
 
@@ -168,7 +168,7 @@ describe("Disputes", (): void => {
         scope.post("/retrieveApplicableDefenseReasons")
             .reply(200, expected);
 
-        const response: DefenseReasonsResponse = await disputesService.retrieveApplicableDefenseReasons(request);
+        const response: DefenseReasonsResponse = await disputesService.DisputesApi.retrieveApplicableDefenseReasons(request);
         expect(response.disputeServiceResult.success).toEqual(true);
         expect(response.defenseReasons?.length).toEqual(4);
     });
@@ -184,7 +184,7 @@ describe("Disputes", (): void => {
         scope.post("/supplyDefenseDocument")
             .reply(200, expected);
 
-        const response: SupplyDefenseDocumentResponse = await disputesService.supplyDefenseDocument(request);
+        const response: SupplyDefenseDocumentResponse = await disputesService.DisputesApi.supplyDefenseDocument(request);
         expect(response.disputeServiceResult.success).toEqual(true);
     });
 });

src/__tests__/management.spec.ts

@@ -584,7 +584,7 @@ describe("Management", (): void => {
                     expect(error.apiError).toBeTruthy();
                     expect(error.apiError?.errorCode).toBe("31_007");
                     expect(error.apiError?.title).toBe("Invalid user information provided.");
-                    expect(error.apiError?.type).toBe("https://docs.adyen.com/errors/validation")
+                    expect(error.apiError?.type).toBe("https://docs.adyen.com/errors/validation");
                     expect(error.apiError?.invalidFields).toBeTruthy();
                     expect(error.apiError?.invalidFields?.length).toBe(1);                    
                 } else {

src/__tests__/storedValue.spec.ts

@@ -51,7 +51,7 @@ describe("StoredValue", (): void => {
             "reference": "YOUR_REFERENCE"
         };
 
-        const issueResponse: storedValue.StoredValueIssueResponse = await storedValueService.issue(issueRequest);
+        const issueResponse: storedValue.StoredValueIssueResponse = await storedValueService.StoredValueApi.issue(issueRequest);
         expect(issueResponse.pspReference).toEqual("851564651069192J");
 
     });
@@ -81,7 +81,7 @@ describe("StoredValue", (): void => {
             "reference": "YOUR_REFERENCE"
         };
 
-        const issueResponse: storedValue.StoredValueIssueResponse = await storedValueService.issue(issueRequest);
+        const issueResponse: storedValue.StoredValueIssueResponse = await storedValueService.StoredValueApi.issue(issueRequest);
         expect(issueResponse.pspReference).toEqual("851564651069192J");
 
     });
@@ -113,7 +113,7 @@ describe("StoredValue", (): void => {
             "reference": "YOUR_REFERENCE"
         };
 
-        const changeStatusResponse: storedValue.StoredValueStatusChangeResponse = await storedValueService.changeStatus(statusRequest);
+        const changeStatusResponse: storedValue.StoredValueStatusChangeResponse = await storedValueService.StoredValueApi.changeStatus(statusRequest);
         expect(changeStatusResponse.pspReference).toEqual("851564652149588K");
     });
 
@@ -141,7 +141,7 @@ describe("StoredValue", (): void => {
             "reference": "YOUR_REFERENCE"
         };
 
-        const changeStatusResponse: storedValue.StoredValueStatusChangeResponse = await storedValueService.changeStatus(statusRequest);
+        const changeStatusResponse: storedValue.StoredValueStatusChangeResponse = await storedValueService.StoredValueApi.changeStatus(statusRequest);
         expect(changeStatusResponse.pspReference).toEqual("851564652149588K");
     });
 
@@ -172,7 +172,7 @@ describe("StoredValue", (): void => {
             "reference": "YOUR_REFERENCE"
         };
 
-        const loadResponse: storedValue.StoredValueLoadResponse = await storedValueService.load(loadRequest);
+        const loadResponse: storedValue.StoredValueLoadResponse = await storedValueService.StoredValueApi.load(loadRequest);
         expect(loadResponse.pspReference).toEqual("851564654294247B");
     });
 
@@ -198,7 +198,7 @@ describe("StoredValue", (): void => {
             "reference": "YOUR_REFERENCE"
         };
 
-        const checkBalanceResponse: storedValue.StoredValueBalanceCheckResponse = await storedValueService.checkBalance(checkBalanceRequest);
+        const checkBalanceResponse: storedValue.StoredValueBalanceCheckResponse = await storedValueService.StoredValueApi.checkBalance(checkBalanceRequest);
         expect(checkBalanceResponse.pspReference).toEqual("881564657480267D");
     });
 
@@ -228,7 +228,7 @@ describe("StoredValue", (): void => {
             "reference": "YOUR_REFERENCE"
         };
 
-        const mergeBalanceResponse: storedValue.StoredValueBalanceMergeResponse = await storedValueService.mergeBalance(mergeBalanceRequest);
+        const mergeBalanceResponse: storedValue.StoredValueBalanceMergeResponse = await storedValueService.StoredValueApi.mergeBalance(mergeBalanceRequest);
         expect(mergeBalanceResponse.pspReference).toEqual("881564657480267D");
     });
 
@@ -249,7 +249,7 @@ describe("StoredValue", (): void => {
             "reference": "YOUR_REFERENCE"
         };
 
-        const voidTransactionResponse: storedValue.StoredValueVoidResponse = await storedValueService.voidTransaction(voidTransactionRequest);
+        const voidTransactionResponse: storedValue.StoredValueVoidResponse = await storedValueService.StoredValueApi.voidTransaction(voidTransactionRequest);
         expect(voidTransactionResponse.pspReference).toEqual("851564673300692A");
     });
 });

src/services/balanceControl/balanceControlApi.ts

@@ -0,0 +1,56 @@
+/*
+ * The version of the OpenAPI document: v1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit this class manually.
+ */
+
+
+import getJsonResponse from "../../helpers/getJsonResponse";
+import Service from "../../service";
+import Client from "../../client";
+import { IRequest } from "../../typings/requestOptions";
+import Resource from "../resource";
+
+import { ObjectSerializer } from "../../typings/balanceControl/objectSerializer";
+import { BalanceTransferRequest } from "../../typings/balanceControl/models";
+import { BalanceTransferResponse } from "../../typings/balanceControl/models";
+
+/**
+ * API handler for BalanceControlApi
+ */
+export class BalanceControlApi extends Service {
+
+    private readonly API_BASEPATH: string = "https://pal-test.adyen.com/pal/servlet/BalanceControl/v1";
+    private baseUrl: string;
+
+    public constructor(client: Client){
+        super(client);
+        this.baseUrl = this.createBaseUrl(this.API_BASEPATH);
+    }
+
+    /**
+    * @summary Start a balance transfer
+    * @param balanceTransferRequest {@link BalanceTransferRequest } 
+    * @param requestOptions {@link IRequest.Options }
+    * @return {@link BalanceTransferResponse }
+    *
+	* @deprecated since Adyen Balance Control API v1
+    */
+    public async balanceTransfer(balanceTransferRequest: BalanceTransferRequest, requestOptions?: IRequest.Options): Promise<BalanceTransferResponse> {
+        const endpoint = `${this.baseUrl}/balanceTransfer`;
+        const resource = new Resource(this, endpoint);
+        
+        const request: BalanceTransferRequest = ObjectSerializer.serialize(balanceTransferRequest, "BalanceTransferRequest", "");
+        const response = await getJsonResponse<BalanceTransferRequest, BalanceTransferResponse>(
+            resource,
+            request,
+            { ...requestOptions, method: "POST" }
+        );
+
+        return ObjectSerializer.deserialize(response, "BalanceTransferResponse", "");
+    }
+
+}

src/services/balanceControl/index.ts

@@ -0,0 +1,24 @@
+/*
+ * The version of the OpenAPI document: v1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit this class manually.
+ */
+
+import { BalanceControlApi } from "./balanceControlApi";
+
+import Service from "../../service";
+import Client from "../../client";
+
+export default class BalanceControlAPI extends Service {
+    
+    public constructor(client: Client) {
+        super(client);
+    }
+
+    public get BalanceControlApi() {
+        return new BalanceControlApi(this.client);
+    }
+}