Update method descriptions with possible values for query params (#1288)

* Update method descriptions with possible values for query params and update readme with an example

* Update README.md

* add test with IRequest

* add options

* Update README.md

Co-authored-by: Michael Paul <michael.paul@adyen.com>

* Update README.md

Co-authored-by: Alessio Zampatti <alessio.zampatti@adyen.com>

---------

Co-authored-by: system-mr <systemmr@adyen.com>
Co-authored-by: Michael Paul <michael.paul@adyen.com>
Co-authored-by: Alessio Zampatti <alessio.zampatti@adyen.com>

Author: 4 people

README.md

@@ -119,6 +119,17 @@ 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). 
+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.
+```javascript
+const requestOptions: IRequest.Options = {
+    params: {
+        limit: "5",
+        offset: "10"
+    }
+};
+await balancePlatformService.AccountHoldersApi.getAllBalanceAccountsOfAccountHolder("AH32272223222B5CM4MWJ892H", requestOptions);
+```
 
 ### Step 1: Require the parts of the module you want to use
 

src/__tests__/balancePlatform.spec.ts

@@ -3,6 +3,7 @@ import Client from "../client";
 import { createClient } from "../__mocks__/base";
 import BalancePlatform from "../services/balancePlatform";
 import { balancePlatform }  from "../typings";
+import {IRequest} from "../typings/requestOptions";
 
 let client: Client;
 let balancePlatformService: BalancePlatform;
@@ -166,13 +167,13 @@ describe("Balance Platform", (): void => {
                     "hasNext": true,
                     "hasPrevious": false
                 });
-
-            const response: balancePlatform.PaginatedBalanceAccountsResponse = await balancePlatformService.AccountHoldersApi.getAllBalanceAccountsOfAccountHolder("AH32272223222B5CM4MWJ892H", {
+            const requestOptions: IRequest.Options = {
                 params: {
-                    "limit": "5",
-                    "offset": "10"
+                    limit: "5",
+                    offset: "10"
                 }
-            });
+            };
+            const response: balancePlatform.PaginatedBalanceAccountsResponse = await balancePlatformService.AccountHoldersApi.getAllBalanceAccountsOfAccountHolder("AH32272223222B5CM4MWJ892H", requestOptions);
 
             expect(response.balanceAccounts[0].id).toBe("BA32272223222B59K6ZXHBFN6");
         });

templates/typescript/api_summary.mustache

@@ -2,10 +2,16 @@
 {{#summary}}
     * @summary {{&summary}}
 {{/summary}}
-{{#allParams}}
+{{#pathParams}}
     * @param {{paramName}} {@link {{dataType}} } {{description}}
-{{/allParams}}
-    * @param requestOptions {@link IRequest.Options}
+{{/pathParams}}
+{{#bodyParams}}
+    * @param {{paramName}} {@link {{dataType}} } {{description}}
+{{/bodyParams}}
+    * @param requestOptions {@link IRequest.Options }
+{{#hasQueryParams}}
+    * @example send query parameters through requestOptions: { params: { {{#queryParams}}{{#lambda.camelcase}}{{paramName}}{{/lambda.camelcase}}: "{{{dataType}}}"{{^-last}}, {{/-last}}{{/queryParams}} } }
+{{/hasQueryParams}}
 {{#returnType}}
     * @return {@link {{.}} }
 {{/returnType}}