Merge pull request #1595 from Adyen/custom-request-headers

Add test to verify custom request headers

Author: gcatanese

README.md

@@ -125,8 +125,22 @@ checkoutApi.PaymentsApi.payments(paymentRequest)
   .then(paymentResponse => console.log(paymentResponse.pspReference))
   .catch(error => console.log(error));
 ```
-If you want to pass query string parameters, you can use the `params` field from [IRequest](/src/typings/requestOptions.ts) (also used for idempotency-key and other header fields). 
+If you want to pass query string parameters, you can use the `params` field from [IRequest](/src/typings/requestOptions.ts) (also used for idempotency-key and other header fields).
 The method descriptions contain an example of the possible values you can send to the API for the query parameters, just as stated in the API explorer.
+
+You can also include custom HTTP headers in your request by using the `headers` property within `IRequest.Options`. This can be useful for sending additional metadata or authentication details that are not part of the standard API request body or query parameters.
+
+```typescript
+const requestOptions: IRequest.Options = {
+    headers: {
+        "X-Custom-Header": "MyValue",
+        "Another-Custom-Header": "AnotherValue"
+    }
+};
+checkoutApi.PaymentsApi.payments(paymentRequest, requestOptions)
+  .then(response => console.log("Payment successful:", response))
+  .catch(error => console.error("Payment failed:", error));
+```
 ```javascript
 const requestOptions: IRequest.Options = {
     params: {

src/__tests__/httpClient.spec.ts

@@ -159,6 +159,32 @@ describe("HTTP Client", function (): void {
         expect(response).toEqual<binlookup.ThreeDSAvailabilityResponse>(threeDSAvailabilitySuccessResponse);
     });
 
+    test("should make a request with custom headers", async (): Promise<void> => {
+        const client = createClient();
+        const checkout = new CheckoutAPI(client);
+
+        const customHeaderKey = "X-Custom-Header";
+        const customHeaderValue = "my-custom-value";
+
+        const scope = nock("https://checkout-test.adyen.com/v71", {
+            reqheaders: {
+                [customHeaderKey]: (headerValue) => {
+                    expect(headerValue).toBeTruthy();
+                    expect(headerValue).toEqual(customHeaderValue);
+                    return true;
+                },
+            },
+        });
+
+        scope.post("/paymentMethods").reply(200, paymentMethodsSuccess);
+        const requestOptions = { headers: { [customHeaderKey]: customHeaderValue } };
+
+        const response = await checkout.PaymentsApi.paymentMethods({ "merchantAccount": "testMerchantAccount" }, requestOptions);
+
+        expect(response.paymentMethods).toBeTruthy();
+        expect(scope.isDone()).toBe(true);
+    });
+
     test("should add default applicationInfo to the headers", async (): Promise<void> => {
         const client = createClient();
         const checkout = new CheckoutAPI(client);