Merge pull request #1609 from Adyen/sdk-automation/checkout

[checkout] Code generation: update services and models

Author: gcatanese

src/__mocks__/checkout/forwardResponse.json

@@ -0,0 +1,11 @@
+{
+  "pspReference": "PSP123456789",
+  "response": {
+    "body": "{\"data\": {\"tokenizeCreditCard\": {\"paymentMethod\": {\"id\": \"PAYMENT_METHOD_ID\"}}}}",
+    "headers": {
+      "Content-Type": "application/json"
+    },
+    "status": 200
+  },
+  "storedPaymentMethodId": "PAYMENT_METHOD_ID"
+}

src/__tests__/checkout.spec.ts

@@ -15,6 +15,7 @@ import { SessionResultResponse } from "../typings/checkout/sessionResultResponse
 import { payments3DS2NativeAction } from "../__mocks__/checkout/payments3DS2NativeAction";
 import { EnvironmentEnum } from "../config";
 import { Types } from "..";
+import forwardResponse from "../__mocks__/checkout/forwardResponse.json";
 
 const merchantAccount = process.env.ADYEN_MERCHANT!;
 const reference = "Your order number";
@@ -683,4 +684,48 @@ describe("Checkout", (): void => {
         expect(resultOfPaymentSessionResponse.id).toEqual("CS12345678");
         expect(resultOfPaymentSessionResponse.status).toEqual(SessionResultResponse.StatusEnum.Completed);
     });
+
+    test("Should forward token", async (): Promise<void> => {
+        scope.post("/forward")
+            .reply(200, forwardResponse);
+
+        const body = {
+            amount: {
+                value: 100,
+                currency: "USD"
+            },
+            paymentMethod: {
+                creditCard: {
+                    holderName: "{{holderName}}",
+                    number: "{{number}}",
+                    expiryMonth: "{{expiryMonth}}",
+                    expiryYear: "{{expiryYear}}"
+                }
+            }
+        };
+
+        const checkoutForwardRequest: Types.checkout.CheckoutForwardRequest = {
+            merchantAccount: "YOUR_MERCHANT_ACCOUNT",
+            shopperReference: "YOUR_SHOPPER_REFERENCE",
+            storedPaymentMethodId: "M12345677890",
+            baseUrl: "http://thirdparty.example.com",
+            request: {
+                httpMethod: Types.checkout.CheckoutOutgoingForwardRequest.HttpMethodEnum.Post,
+                urlSuffix: "/payments",
+                credentials: "YOUR_CREDENTIALS_FOR_THE_THIRD_PARTY",
+                headers: {
+                    "Authorization": "Basic {{credentials}}",
+                },
+                body: JSON.stringify(body),
+            }
+        };
+
+        const response: Types.checkout.CheckoutForwardResponse = await checkoutService.RecurringApi.forward(checkoutForwardRequest);
+
+        expect(response.pspReference).toEqual("PSP123456789");
+        expect(response.storedPaymentMethodId).toEqual("PAYMENT_METHOD_ID");
+        expect(response.response).toBeDefined();
+        expect(response.response.status).toEqual(200);
+        expect(response.response.body).toContain("PAYMENT_METHOD_ID");
+    });
 });

src/services/checkout/recurringApi.ts

@@ -15,6 +15,8 @@ import { IRequest } from "../../typings/requestOptions";
 import Resource from "../resource";
 
 import { ObjectSerializer } from "../../typings/checkout/objectSerializer";
+import { CheckoutForwardRequest } from "../../typings/checkout/models";
+import { CheckoutForwardResponse } from "../../typings/checkout/models";
 import { ListStoredPaymentMethodsResponse } from "../../typings/checkout/models";
 import { StoredPaymentMethodRequest } from "../../typings/checkout/models";
 import { StoredPaymentMethodResource } from "../../typings/checkout/models";
@@ -58,6 +60,26 @@ export class RecurringApi extends Service {
         );
     }
 
+    /**
+    * @summary Forward stored payment details
+    * @param checkoutForwardRequest {@link CheckoutForwardRequest } 
+    * @param requestOptions {@link IRequest.Options }
+    * @return {@link CheckoutForwardResponse }
+    */
+    public async forward(checkoutForwardRequest: CheckoutForwardRequest, requestOptions?: IRequest.Options): Promise<CheckoutForwardResponse> {
+        const endpoint = `${this.baseUrl}/forward`;
+        const resource = new Resource(this, endpoint);
+        
+        const request: CheckoutForwardRequest = ObjectSerializer.serialize(checkoutForwardRequest, "CheckoutForwardRequest");
+        const response = await getJsonResponse<CheckoutForwardRequest, CheckoutForwardResponse>(
+            resource,
+            request,
+            { ...requestOptions, method: "POST" }
+        );
+
+        return ObjectSerializer.deserialize(response, "CheckoutForwardResponse");
+    }
+
     /**
     * @summary Get tokens for stored payment details
     * @param requestOptions {@link IRequest.Options }

src/typings/checkout/achDetails.ts

@@ -49,6 +49,10 @@ export class AchDetails {
     */
     "recurringDetailReference"?: string;
     /**
+    * Base64-encoded JSON object containing SDK related parameters required by the SDK
+    */
+    "sdkData"?: string;
+    /**
     * This is the `recurringDetailReference` returned in the response when you created the token.
     */
     "storedPaymentMethodId"?: string;
@@ -120,6 +124,12 @@ export class AchDetails {
             "type": "string",
             "format": ""
         },
+        {
+            "name": "sdkData",
+            "baseName": "sdkData",
+            "type": "string",
+            "format": ""
+        },
         {
             "name": "storedPaymentMethodId",
             "baseName": "storedPaymentMethodId",

src/typings/checkout/additionalDataLevel23.ts

@@ -34,7 +34,7 @@ export class AdditionalDataLevel23 {
     */
     "enhancedSchemeData_freightAmount"?: string;
     /**
-    * The code that identifies the item in a standardized commodity coding scheme. There are different commodity coding schemes: * [UNSPSC commodity codes](https://www.unspsc.org/) * [HS commodity codes](https://www.wcoomd.org/en/topics/nomenclature/overview.aspx) * [NAICS commodity codes](https://www.census.gov/naics/) * [NAPCS commodity codes](https://www.census.gov/naics/napcs/)   * Encoding: ASCII * Max length: 12 characters * Must not start with a space or be all spaces. * Must not be all zeros.
+    * The code that identifies the item in a standardized commodity coding scheme. There are different commodity coding schemes: * [UNSPSC commodity codes](https://www.ungm.org/public/unspsc) * [HS commodity codes](https://www.wcoomd.org/en/topics/nomenclature/overview.aspx) * [NAICS commodity codes](https://www.census.gov/naics/) * [NAPCS commodity codes](https://www.census.gov/naics/napcs/)   * Encoding: ASCII * Max length: 12 characters * Must not start with a space or be all spaces. * Must not be all zeros.
     */
     "enhancedSchemeData_itemDetailLine_itemNr_commodityCode"?: string;
     /**

src/typings/checkout/affirmDetails.ts

@@ -14,6 +14,10 @@ export class AffirmDetails {
     */
     "checkoutAttemptId"?: string;
     /**
+    * Base64-encoded JSON object containing SDK related parameters required by the SDK
+    */
+    "sdkData"?: string;
+    /**
     * **affirm**
     */
     "type"?: AffirmDetails.TypeEnum;
@@ -29,6 +33,12 @@ export class AffirmDetails {
             "type": "string",
             "format": ""
         },
+        {
+            "name": "sdkData",
+            "baseName": "sdkData",
+            "type": "string",
+            "format": ""
+        },
         {
             "name": "type",
             "baseName": "type",

src/typings/checkout/afterpayDetails.ts

@@ -33,6 +33,10 @@ export class AfterpayDetails {
     */
     "recurringDetailReference"?: string;
     /**
+    * Base64-encoded JSON object containing SDK related parameters required by the SDK
+    */
+    "sdkData"?: string;
+    /**
     * This is the `recurringDetailReference` returned in the response when you created the token.
     */
     "storedPaymentMethodId"?: string;
@@ -76,6 +80,12 @@ export class AfterpayDetails {
             "type": "string",
             "format": ""
         },
+        {
+            "name": "sdkData",
+            "baseName": "sdkData",
+            "type": "string",
+            "format": ""
+        },
         {
             "name": "storedPaymentMethodId",
             "baseName": "storedPaymentMethodId",

src/typings/checkout/amazonPayDetails.ts

@@ -22,6 +22,10 @@ export class AmazonPayDetails {
     */
     "checkoutSessionId"?: string;
     /**
+    * Base64-encoded JSON object containing SDK related parameters required by the SDK
+    */
+    "sdkData"?: string;
+    /**
     * **amazonpay**
     */
     "type"?: AmazonPayDetails.TypeEnum;
@@ -49,6 +53,12 @@ export class AmazonPayDetails {
             "type": "string",
             "format": ""
         },
+        {
+            "name": "sdkData",
+            "baseName": "sdkData",
+            "type": "string",
+            "format": ""
+        },
         {
             "name": "type",
             "baseName": "type",

src/typings/checkout/amount.ts

@@ -10,11 +10,11 @@
 
 export class Amount {
     /**
-    * The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes).
+    * The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes) of the amount.
     */
     "currency": string;
     /**
-    * The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units).
+    * The numeric value of the amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units).
     */
     "value": number;
 

src/typings/checkout/ancvDetails.ts

@@ -25,6 +25,10 @@ export class AncvDetails {
     */
     "recurringDetailReference"?: string;
     /**
+    * Base64-encoded JSON object containing SDK related parameters required by the SDK
+    */
+    "sdkData"?: string;
+    /**
     * This is the `recurringDetailReference` returned in the response when you created the token.
     */
     "storedPaymentMethodId"?: string;
@@ -56,6 +60,12 @@ export class AncvDetails {
             "type": "string",
             "format": ""
         },
+        {
+            "name": "sdkData",
+            "baseName": "sdkData",
+            "type": "string",
+            "format": ""
+        },
         {
             "name": "storedPaymentMethodId",
             "baseName": "storedPaymentMethodId",