Merge pull request #1515 from Adyen/mandatory-query-params

Transfers API: method signature with required query parameters

Author: gcatanese

src/__tests__/transfers.spec.ts

@@ -47,6 +47,45 @@ describe("Transfers", (): void => {
         expect(response.id).toEqual("1W1UG35U8A9J5ZLG");
     });
 
+    test("should get transfer", async (): Promise<void> => {
+        scope.get("/transfers/123")
+        .reply(200, transfersSuccess);
+        const response: transfers.TransferData = await transfersAPI.TransfersApi.getTransfer("123",);
+        expect(response.id).toEqual("1W1UG35U8A9J5ZLG");
+    });
+
+    test("should list transfers", async (): Promise<void> => {
+        const createdSince = new Date(Date.UTC(2023, 11, 12, 0, 0, 0)); // 12-12-2023 December is month 11
+        const createdUntil = new Date(Date.UTC(2023, 11, 13, 0, 0, 0)); // 13-12-2023 December is month 11
+    
+        scope
+          .get("/transfers")
+          .query({
+            balancePlatform: "platform",
+            createdSince: createdSince.toISOString(),
+            createdUntil: createdUntil.toISOString(),
+          })
+          .reply(200, listTransactionsSuccess);
+    
+        const response: transfers.FindTransfersResponse = await transfersAPI.TransfersApi.getAllTransfers(
+            createdSince,
+            createdUntil,
+            "platform",
+            undefined,
+            undefined,
+            undefined,
+            undefined
+        );
+    
+        expect(response.data?.length).toEqual(3);
+        if (response.data && response.data.length > 0) {
+            expect(response.data[0].id).toEqual("1VVF0D5U66PIUIVP");
+        } else {
+            fail();
+        }
+    });
+
+
     test("should get transaction", async (): Promise<void> => {
         scope.get("/transactions/123")
         .reply(200, getTransactionSuccess);
@@ -68,13 +107,13 @@ describe("Transfers", (): void => {
           .reply(200, listTransactionsSuccess);
 
         const response: transfers.TransactionSearchResponse = await transfersAPI.TransactionsApi.getAllTransactions(
+            createdSince,
+            createdUntil,
             "platform",
             undefined,
             undefined,
             undefined,
-            undefined,
-            createdSince,
-            createdUntil
+            undefined
         );
 
         expect(response.data?.length).toEqual(3);
@@ -84,4 +123,5 @@ describe("Transfers", (): void => {
             fail();
         }
     });
+
 });

src/services/transfers/capitalApi.ts

@@ -35,7 +35,7 @@ export class CapitalApi extends Service {
     /**
     * @summary Get a capital account
     * @param requestOptions {@link IRequest.Options }
-    * @param counterpartyAccountHolderId {@link string } The counterparty account holder id.
+    * @param counterpartyAccountHolderId {@link string } The counterparty account holder id. 
     * @return {@link CapitalGrants }
     *
 	* @deprecated since Transfers API v4
@@ -57,7 +57,7 @@ export class CapitalApi extends Service {
             { ...requestOptions, method: "GET" }
         );
 
-        return ObjectSerializer.deserialize(response, "CapitalGrants", "");
+        return ObjectSerializer.deserialize(response, "CapitalGrants");
     }
 
     /**
@@ -80,7 +80,7 @@ export class CapitalApi extends Service {
             { ...requestOptions, method: "GET" }
         );
 
-        return ObjectSerializer.deserialize(response, "CapitalGrant", "");
+        return ObjectSerializer.deserialize(response, "CapitalGrant");
     }
 
     /**
@@ -96,14 +96,14 @@ export class CapitalApi extends Service {
         const endpoint = `${this.baseUrl}/grants`;
         const resource = new Resource(this, endpoint);
 
-        const request: CapitalGrantInfo = ObjectSerializer.serialize(capitalGrantInfo, "CapitalGrantInfo", "");
+        const request: CapitalGrantInfo = ObjectSerializer.serialize(capitalGrantInfo, "CapitalGrantInfo");
         const response = await getJsonResponse<CapitalGrantInfo, CapitalGrant>(
             resource,
             request,
             { ...requestOptions, method: "POST" }
         );
 
-        return ObjectSerializer.deserialize(response, "CapitalGrant", "");
+        return ObjectSerializer.deserialize(response, "CapitalGrant");
     }
 
 }

src/services/transfers/transactionsApi.ts

@@ -34,17 +34,17 @@ export class TransactionsApi extends Service {
     /**
     * @summary Get all transactions
     * @param requestOptions {@link IRequest.Options }
-    * @param balancePlatform {@link string } The unique identifier of the [balance platform](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balancePlatforms/{id}__queryParam_id).  Required if you don\'t provide a `balanceAccountId` or `accountHolderId`.
-    * @param paymentInstrumentId {@link string } The unique identifier of the [payment instrument](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/paymentInstruments/_id_).  To use this parameter, you must also provide a `balanceAccountId`, `accountHolderId`, or `balancePlatform`.  The `paymentInstrumentId` must be related to the `balanceAccountId` or `accountHolderId` that you provide.
-    * @param accountHolderId {@link string } The unique identifier of the [account holder](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/accountHolders/{id}__queryParam_id).  Required if you don\'t provide a `balanceAccountId` or `balancePlatform`.  If you provide a `balanceAccountId`, the `accountHolderId` must be related to the `balanceAccountId`.
-    * @param balanceAccountId {@link string } The unique identifier of the [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balanceAccounts/{id}__queryParam_id).  Required if you don\'t provide an `accountHolderId` or `balancePlatform`.  If you provide an `accountHolderId`, the `balanceAccountId` must be related to the `accountHolderId`.
-    * @param cursor {@link string } The `cursor` returned in the links of the previous response.
-    * @param createdSince {@link Date } Only include transactions that have been created on or after this point in time. The value must be in ISO 8601 format. For example, **2021-05-30T15:07:40Z**.
-    * @param createdUntil {@link Date } Only include transactions that have been created on or before this point in time. The value must be in ISO 8601 format. For example, **2021-05-30T15:07:40Z**.
-    * @param limit {@link number } The number of items returned per page, maximum of 100 items. By default, the response returns 10 items per page.
+    * @param createdSince {@link Date } (Required) Only include transactions that have been created on or after this point in time. The value must be in ISO 8601 format. For example, **2021-05-30T15:07:40Z**. 
+    * @param createdUntil {@link Date } (Required) Only include transactions that have been created on or before this point in time. The value must be in ISO 8601 format. For example, **2021-05-30T15:07:40Z**. 
+    * @param balancePlatform {@link string } The unique identifier of the [balance platform](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balancePlatforms/{id}__queryParam_id).  Required if you don\'t provide a `balanceAccountId` or `accountHolderId`. 
+    * @param paymentInstrumentId {@link string } The unique identifier of the [payment instrument](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/paymentInstruments/_id_).  To use this parameter, you must also provide a `balanceAccountId`, `accountHolderId`, or `balancePlatform`.  The `paymentInstrumentId` must be related to the `balanceAccountId` or `accountHolderId` that you provide. 
+    * @param accountHolderId {@link string } The unique identifier of the [account holder](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/accountHolders/{id}__queryParam_id).  Required if you don\'t provide a `balanceAccountId` or `balancePlatform`.  If you provide a `balanceAccountId`, the `accountHolderId` must be related to the `balanceAccountId`. 
+    * @param balanceAccountId {@link string } The unique identifier of the [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balanceAccounts/{id}__queryParam_id).  Required if you don\'t provide an `accountHolderId` or `balancePlatform`.  If you provide an `accountHolderId`, the `balanceAccountId` must be related to the `accountHolderId`. 
+    * @param cursor {@link string } The `cursor` returned in the links of the previous response. 
+    * @param limit {@link number } The number of items returned per page, maximum of 100 items. By default, the response returns 10 items per page. 
     * @return {@link TransactionSearchResponse }
     */
-    public async getAllTransactions(balancePlatform?: string, paymentInstrumentId?: string, accountHolderId?: string, balanceAccountId?: string, cursor?: string, createdSince?: Date, createdUntil?: Date, limit?: number, requestOptions?: IRequest.Options): Promise<TransactionSearchResponse> {
+    public async getAllTransactions(createdSince: Date, createdUntil: Date, balancePlatform?: string, paymentInstrumentId?: string, accountHolderId?: string, balanceAccountId?: string, cursor?: string, limit?: number, requestOptions?: IRequest.Options): Promise<TransactionSearchResponse> {
         const endpoint = `${this.baseUrl}/transactions`;
         const resource = new Resource(this, endpoint);
 
@@ -67,7 +67,7 @@ export class TransactionsApi extends Service {
             { ...requestOptions, method: "GET" }
         );
 
-        return ObjectSerializer.deserialize(response, "TransactionSearchResponse", "");
+        return ObjectSerializer.deserialize(response, "TransactionSearchResponse");
     }
 
     /**
@@ -87,7 +87,7 @@ export class TransactionsApi extends Service {
             { ...requestOptions, method: "GET" }
         );
 
-        return ObjectSerializer.deserialize(response, "Transaction", "");
+        return ObjectSerializer.deserialize(response, "Transaction");
     }
 
 }