add query parameters to function arguments (#1304)

* add query parameters to function arguments. applied template checkout only for review

* removed code duplication from queryParameters feature

* fix code smells

* fix code smells on models import statements

* include funtionality for Date query parameters. Tested through Transfers unit tests

Author: wboereboom

src/__tests__/checkout.spec.ts

@@ -13,6 +13,7 @@ import {CheckoutAPI} from "../services";
 import HttpClientException from "../httpClient/httpClientException";
 import { checkout } from "../typings";
 import { IRequest } from "../typings/requestOptions";
+import { SessionResultResponse } from "../typings/checkout/sessionResultResponse";
 
 const merchantAccount = process.env.ADYEN_MERCHANT!;
 const reference = "Your order number";
@@ -386,8 +387,8 @@ describe("Checkout", (): void => {
             originDomains: ["https://www.your-domain.com"],
         };
 
-        nock(`https://checkout-test.adyen.com`)
-            .post(`/v71/originKeys`)
+        nock("https://checkout-test.adyen.com")
+            .post("/v71/originKeys")
             .reply(200, originKeysSuccess);
 
         const originKeysResponse = await checkoutUtility.UtilityApi.originKeys(originKeysRequest);
@@ -521,7 +522,7 @@ describe("Checkout", (): void => {
         expect(applePaySessionResponse.data).toEqual("eyJ2Z...");
     });
 
-    test("Should get stored paymentMethods", async (): Promise<void> => {
+    test("Should get stored paymentMethods using params in requestOptions", async (): Promise<void> => {
         scope.get("/storedPaymentMethods?shopperReference=MYSHOPPERREFERENCE")
         .reply(200, {
             "merchantAccount": "YOUR_MERCHANT_ACCOUNT",
@@ -536,7 +537,7 @@ describe("Checkout", (): void => {
                 shopperReference: "MYSHOPPERREFERENCE"
             }
         };
-        const getStoredPaymentMethodsResponse = await checkoutService.RecurringApi.getTokensForStoredPaymentDetails(requestOptions);
+        const getStoredPaymentMethodsResponse = await checkoutService.RecurringApi.getTokensForStoredPaymentDetails(undefined, undefined, requestOptions);
         expect(getStoredPaymentMethodsResponse.merchantAccount).toEqual("YOUR_MERCHANT_ACCOUNT");
         expect(getStoredPaymentMethodsResponse?.storedPaymentMethods?.length).toBe(1);
     });
@@ -550,4 +551,28 @@ describe("Checkout", (): void => {
         ).resolves.not.toThrowError();
 
     });
+
+    test("Should handle request without query parameters for getResultOfPaymentSession", async(): Promise<void> => {
+        scope.get("/sessions/mySessionIdMock")
+        .reply(200, {
+            "id": "CS12345678",
+            "status": "completed"
+        });
+
+        const resultOfPaymentSessionResponse = await checkoutService.PaymentsApi.getResultOfPaymentSession("mySessionIdMock");
+        expect(resultOfPaymentSessionResponse.id).toEqual("CS12345678");
+        expect(resultOfPaymentSessionResponse.status).toEqual(SessionResultResponse.StatusEnum.Completed);
+    });
+
+    test("Should handle query parameters for getResultOfPaymentSession", async(): Promise<void> => {
+        scope.get("/sessions/mySessionIdMock?sessionResult=sessionResult")
+        .reply(200, {
+            "id": "CS12345678",
+            "status": "completed"
+        });
+
+        const resultOfPaymentSessionResponse = await checkoutService.PaymentsApi.getResultOfPaymentSession("mySessionIdMock", "sessionResult");
+        expect(resultOfPaymentSessionResponse.id).toEqual("CS12345678");
+        expect(resultOfPaymentSessionResponse.status).toEqual(SessionResultResponse.StatusEnum.Completed);
+    });
 });

src/__tests__/transfers.spec.ts

@@ -50,14 +50,14 @@ describe("Transfers", (): void => {
     test("should get transaction", async (): Promise<void> => {
         scope.get("/transactions/123")
         .reply(200, getTransactionSuccess);
-        const response: transfers.Transaction = await transfersAPI.TransactionsApi.getTransaction("123");
+        const response: transfers.Transaction = await transfersAPI.TransactionsApi.getTransaction("123",);
         expect(response.id).toEqual("IZK7C25U7DYVX03Y");
     });
 
     test("should list transactions", async (): Promise<void> => {
-        scope.get("/transactions")
+        scope.get("/transactions?balancePlatform=platform&createdSince=2023-12-12T00%3A00%3A00.000Z&createdUntil=2023-12-13T00%3A00%3A00.000Z")
         .reply(200, listTransactionsSuccess);
-        const response: transfers.TransactionSearchResponse = await transfersAPI.TransactionsApi.getAllTransactions();
+        const response: transfers.TransactionSearchResponse = await transfersAPI.TransactionsApi.getAllTransactions("platform", undefined, undefined, undefined, undefined, new Date("12-12-2023"), new Date("12-13-2023"));
         expect(response.data?.length).toEqual(3);
         if(response.data && response.data?.length > 0) {
             expect(response?.data[0]?.id).toEqual("1VVF0D5U66PIUIVP");

src/services/checkout/classicCheckoutSDKApi.ts

@@ -10,13 +10,15 @@
 import getJsonResponse from "../../helpers/getJsonResponse";
 import Service from "../../service";
 import Client from "../../client";
-import { PaymentSetupRequest } from "../../typings/checkout/models";
-import { PaymentSetupResponse } from "../../typings/checkout/models";
-import { PaymentVerificationRequest } from "../../typings/checkout/models";
-import { PaymentVerificationResponse } from "../../typings/checkout/models";
+import { 
+    PaymentSetupRequest,
+    PaymentSetupResponse,
+    PaymentVerificationRequest,
+    PaymentVerificationResponse,
+    ObjectSerializer
+} from "../../typings/checkout/models";
 import { IRequest } from "../../typings/requestOptions";
 import Resource from "../resource";
-import { ObjectSerializer } from "../../typings/checkout/models";
 
 export class ClassicCheckoutSDKApi extends Service {
 
@@ -30,9 +32,8 @@ export class ClassicCheckoutSDKApi extends Service {
 
     /**
     * @summary Create a payment session
-    * @param idempotencyKey {@link string } A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).
     * @param paymentSetupRequest {@link PaymentSetupRequest } 
-    * @param requestOptions {@link IRequest.Options}
+    * @param requestOptions {@link IRequest.Options }
     * @return {@link PaymentSetupResponse }
     */
     public async paymentSession(paymentSetupRequest: PaymentSetupRequest, requestOptions?: IRequest.Options): Promise<PaymentSetupResponse> {
@@ -49,9 +50,8 @@ export class ClassicCheckoutSDKApi extends Service {
 
     /**
     * @summary Verify a payment result
-    * @param idempotencyKey {@link string } A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).
     * @param paymentVerificationRequest {@link PaymentVerificationRequest } 
-    * @param requestOptions {@link IRequest.Options}
+    * @param requestOptions {@link IRequest.Options }
     * @return {@link PaymentVerificationResponse }
     */
     public async verifyPaymentResult(paymentVerificationRequest: PaymentVerificationRequest, requestOptions?: IRequest.Options): Promise<PaymentVerificationResponse> {

src/services/checkout/donationsApi.ts

@@ -0,0 +1,48 @@
+/*
+ * The version of the OpenAPI document: v71
+ * 
+ *
+ * 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 { 
+    DonationPaymentRequest,
+    DonationPaymentResponse,
+    ObjectSerializer
+} from "../../typings/checkout/models";
+import { IRequest } from "../../typings/requestOptions";
+import Resource from "../resource";
+
+export class DonationsApi extends Service {
+
+    private readonly API_BASEPATH: string = "https://checkout-test.adyen.com/v71";
+    private baseUrl: string;
+
+    public constructor(client: Client){
+        super(client);
+        this.baseUrl = this.createBaseUrl(this.API_BASEPATH);
+    }
+
+    /**
+    * @summary Start a transaction for donations
+    * @param donationPaymentRequest {@link DonationPaymentRequest } 
+    * @param requestOptions {@link IRequest.Options }
+    * @return {@link DonationPaymentResponse }
+    */
+    public async donations(donationPaymentRequest: DonationPaymentRequest, requestOptions?: IRequest.Options): Promise<DonationPaymentResponse> {
+        const endpoint = `${this.baseUrl}/donations`;
+        const resource = new Resource(this, endpoint);
+        const request: DonationPaymentRequest = ObjectSerializer.serialize(donationPaymentRequest, "DonationPaymentRequest");
+        const response = await getJsonResponse<DonationPaymentRequest, DonationPaymentResponse>(
+            resource,
+            request,
+            { ...requestOptions, method: "POST" }
+        );
+        return ObjectSerializer.deserialize(response, "DonationPaymentResponse");
+    }
+}

src/services/checkout/index.ts

@@ -8,6 +8,7 @@
  */
 
 import { ClassicCheckoutSDKApi } from "./classicCheckoutSDKApi";
+import { DonationsApi } from "./donationsApi";
 import { ModificationsApi } from "./modificationsApi";
 import { OrdersApi } from "./ordersApi";
 import { PaymentLinksApi } from "./paymentLinksApi";
@@ -28,6 +29,10 @@ export default class CheckoutAPI extends Service {
         return new ClassicCheckoutSDKApi(this.client);
     }
 
+    public get DonationsApi() {
+        return new DonationsApi(this.client);
+    }
+
     public get ModificationsApi() {
         return new ModificationsApi(this.client);
     }

src/services/checkout/modificationsApi.ts

@@ -10,21 +10,23 @@
 import getJsonResponse from "../../helpers/getJsonResponse";
 import Service from "../../service";
 import Client from "../../client";
-import { PaymentAmountUpdateRequest } from "../../typings/checkout/models";
-import { PaymentAmountUpdateResponse } from "../../typings/checkout/models";
-import { PaymentCancelRequest } from "../../typings/checkout/models";
-import { PaymentCancelResponse } from "../../typings/checkout/models";
-import { PaymentCaptureRequest } from "../../typings/checkout/models";
-import { PaymentCaptureResponse } from "../../typings/checkout/models";
-import { PaymentRefundRequest } from "../../typings/checkout/models";
-import { PaymentRefundResponse } from "../../typings/checkout/models";
-import { PaymentReversalRequest } from "../../typings/checkout/models";
-import { PaymentReversalResponse } from "../../typings/checkout/models";
-import { StandalonePaymentCancelRequest } from "../../typings/checkout/models";
-import { StandalonePaymentCancelResponse } from "../../typings/checkout/models";
+import { 
+    PaymentAmountUpdateRequest,
+    PaymentAmountUpdateResponse,
+    PaymentCancelRequest,
+    PaymentCancelResponse,
+    PaymentCaptureRequest,
+    PaymentCaptureResponse,
+    PaymentRefundRequest,
+    PaymentRefundResponse,
+    PaymentReversalRequest,
+    PaymentReversalResponse,
+    StandalonePaymentCancelRequest,
+    StandalonePaymentCancelResponse,
+    ObjectSerializer
+} from "../../typings/checkout/models";
 import { IRequest } from "../../typings/requestOptions";
 import Resource from "../resource";
-import { ObjectSerializer } from "../../typings/checkout/models";
 
 export class ModificationsApi extends Service {
 
@@ -38,9 +40,8 @@ export class ModificationsApi extends Service {
 
     /**
     * @summary Cancel an authorised payment
-    * @param idempotencyKey {@link string } A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).
     * @param standalonePaymentCancelRequest {@link StandalonePaymentCancelRequest } 
-    * @param requestOptions {@link IRequest.Options}
+    * @param requestOptions {@link IRequest.Options }
     * @return {@link StandalonePaymentCancelResponse }
     */
     public async cancelAuthorisedPayment(standalonePaymentCancelRequest: StandalonePaymentCancelRequest, requestOptions?: IRequest.Options): Promise<StandalonePaymentCancelResponse> {
@@ -58,9 +59,8 @@ export class ModificationsApi extends Service {
     /**
     * @summary Update an authorised amount
     * @param paymentPspReference {@link string } The [&#x60;pspReference&#x60;](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment.
-    * @param idempotencyKey {@link string } A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).
     * @param paymentAmountUpdateRequest {@link PaymentAmountUpdateRequest } 
-    * @param requestOptions {@link IRequest.Options}
+    * @param requestOptions {@link IRequest.Options }
     * @return {@link PaymentAmountUpdateResponse }
     */
     public async updateAuthorisedAmount(paymentPspReference: string, paymentAmountUpdateRequest: PaymentAmountUpdateRequest, requestOptions?: IRequest.Options): Promise<PaymentAmountUpdateResponse> {
@@ -79,9 +79,8 @@ export class ModificationsApi extends Service {
     /**
     * @summary Cancel an authorised payment
     * @param paymentPspReference {@link string } The [&#x60;pspReference&#x60;](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to cancel. 
-    * @param idempotencyKey {@link string } A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).
     * @param paymentCancelRequest {@link PaymentCancelRequest } 
-    * @param requestOptions {@link IRequest.Options}
+    * @param requestOptions {@link IRequest.Options }
     * @return {@link PaymentCancelResponse }
     */
     public async cancelAuthorisedPaymentByPspReference(paymentPspReference: string, paymentCancelRequest: PaymentCancelRequest, requestOptions?: IRequest.Options): Promise<PaymentCancelResponse> {
@@ -100,9 +99,8 @@ export class ModificationsApi extends Service {
     /**
     * @summary Capture an authorised payment
     * @param paymentPspReference {@link string } The [&#x60;pspReference&#x60;](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to capture.
-    * @param idempotencyKey {@link string } A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).
     * @param paymentCaptureRequest {@link PaymentCaptureRequest } 
-    * @param requestOptions {@link IRequest.Options}
+    * @param requestOptions {@link IRequest.Options }
     * @return {@link PaymentCaptureResponse }
     */
     public async captureAuthorisedPayment(paymentPspReference: string, paymentCaptureRequest: PaymentCaptureRequest, requestOptions?: IRequest.Options): Promise<PaymentCaptureResponse> {
@@ -121,9 +119,8 @@ export class ModificationsApi extends Service {
     /**
     * @summary Refund a captured payment
     * @param paymentPspReference {@link string } The [&#x60;pspReference&#x60;](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to refund.
-    * @param idempotencyKey {@link string } A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).
     * @param paymentRefundRequest {@link PaymentRefundRequest } 
-    * @param requestOptions {@link IRequest.Options}
+    * @param requestOptions {@link IRequest.Options }
     * @return {@link PaymentRefundResponse }
     */
     public async refundCapturedPayment(paymentPspReference: string, paymentRefundRequest: PaymentRefundRequest, requestOptions?: IRequest.Options): Promise<PaymentRefundResponse> {
@@ -142,9 +139,8 @@ export class ModificationsApi extends Service {
     /**
     * @summary Refund or cancel a payment
     * @param paymentPspReference {@link string } The [&#x60;pspReference&#x60;](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to reverse. 
-    * @param idempotencyKey {@link string } A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).
     * @param paymentReversalRequest {@link PaymentReversalRequest } 
-    * @param requestOptions {@link IRequest.Options}
+    * @param requestOptions {@link IRequest.Options }
     * @return {@link PaymentReversalResponse }
     */
     public async refundOrCancelPayment(paymentPspReference: string, paymentReversalRequest: PaymentReversalRequest, requestOptions?: IRequest.Options): Promise<PaymentReversalResponse> {

src/services/checkout/ordersApi.ts

@@ -10,15 +10,17 @@
 import getJsonResponse from "../../helpers/getJsonResponse";
 import Service from "../../service";
 import Client from "../../client";
-import { BalanceCheckRequest } from "../../typings/checkout/models";
-import { BalanceCheckResponse } from "../../typings/checkout/models";
-import { CancelOrderRequest } from "../../typings/checkout/models";
-import { CancelOrderResponse } from "../../typings/checkout/models";
-import { CreateOrderRequest } from "../../typings/checkout/models";
-import { CreateOrderResponse } from "../../typings/checkout/models";
+import { 
+    BalanceCheckRequest,
+    BalanceCheckResponse,
+    CancelOrderRequest,
+    CancelOrderResponse,
+    CreateOrderRequest,
+    CreateOrderResponse,
+    ObjectSerializer
+} from "../../typings/checkout/models";
 import { IRequest } from "../../typings/requestOptions";
 import Resource from "../resource";
-import { ObjectSerializer } from "../../typings/checkout/models";
 
 export class OrdersApi extends Service {
 
@@ -32,9 +34,8 @@ export class OrdersApi extends Service {
 
     /**
     * @summary Create an order
-    * @param idempotencyKey {@link string } A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).
     * @param createOrderRequest {@link CreateOrderRequest } 
-    * @param requestOptions {@link IRequest.Options}
+    * @param requestOptions {@link IRequest.Options }
     * @return {@link CreateOrderResponse }
     */
     public async orders(createOrderRequest: CreateOrderRequest, requestOptions?: IRequest.Options): Promise<CreateOrderResponse> {
@@ -51,9 +52,8 @@ export class OrdersApi extends Service {
 
     /**
     * @summary Cancel an order
-    * @param idempotencyKey {@link string } A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).
     * @param cancelOrderRequest {@link CancelOrderRequest } 
-    * @param requestOptions {@link IRequest.Options}
+    * @param requestOptions {@link IRequest.Options }
     * @return {@link CancelOrderResponse }
     */
     public async cancelOrder(cancelOrderRequest: CancelOrderRequest, requestOptions?: IRequest.Options): Promise<CancelOrderResponse> {
@@ -70,9 +70,8 @@ export class OrdersApi extends Service {
 
     /**
     * @summary Get the balance of a gift card
-    * @param idempotencyKey {@link string } A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).
     * @param balanceCheckRequest {@link BalanceCheckRequest } 
-    * @param requestOptions {@link IRequest.Options}
+    * @param requestOptions {@link IRequest.Options }
     * @return {@link BalanceCheckResponse }
     */
     public async getBalanceOfGiftCard(balanceCheckRequest: BalanceCheckRequest, requestOptions?: IRequest.Options): Promise<BalanceCheckResponse> {