fix(spec): fix wrong query parameters

algolia/api-clients-automation#330

Co-authored-by: Clément Vannicatte <[email protected]>

Author: algolia-bot

packages/client-abtesting/src/abtestingApi.ts

@@ -74,10 +74,6 @@ export function createAbtestingApi(
       addABTestsRequest: AddABTestsRequest,
       requestOptions?: RequestOptions
     ): Promise<ABTestResponse> {
-      const requestPath = '/2/abtests';
-      const headers: Headers = {};
-      const queryParameters: QueryParameters = {};
-
       if (!addABTestsRequest) {
         throw new Error(
           'Parameter `addABTestsRequest` is required when calling `addABTests`.'
@@ -100,6 +96,10 @@ export function createAbtestingApi(
         );
       }
 
+      const requestPath = '/2/abtests';
+      const headers: Headers = {};
+      const queryParameters: QueryParameters = {};
+
       const request: Request = {
         method: 'POST',
         path: requestPath,
@@ -122,24 +122,20 @@ export function createAbtestingApi(
      * @summary Send requests to the Algolia REST API.
      * @param del - The del object.
      * @param del.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
-     * @param del.parameters - URL-encoded query string. Force some query parameters to be applied for each query made with this API key.
+     * @param del.parameters - Query parameters to be applied to the current query.
      * @param del.body - The parameters to send with the custom request.
      */
     del(
       { path, parameters, body }: DelProps,
       requestOptions?: RequestOptions
     ): Promise<Record<string, any>> {
-      const requestPath = '/1{path}'.replace('{path}', String(path));
-      const headers: Headers = {};
-      const queryParameters: QueryParameters = {};
-
       if (!path) {
         throw new Error('Parameter `path` is required when calling `del`.');
       }
 
-      if (parameters !== undefined) {
-        queryParameters.parameters = parameters.toString();
-      }
+      const requestPath = '/1{path}'.replace('{path}', path);
+      const headers: Headers = {};
+      const queryParameters: QueryParameters = parameters || {};
 
       const request: Request = {
         method: 'DELETE',
@@ -168,19 +164,19 @@ export function createAbtestingApi(
       { id }: DeleteABTestProps,
       requestOptions?: RequestOptions
     ): Promise<ABTestResponse> {
-      const requestPath = '/2/abtests/{id}'.replace(
-        '{id}',
-        encodeURIComponent(String(id))
-      );
-      const headers: Headers = {};
-      const queryParameters: QueryParameters = {};
-
       if (!id) {
         throw new Error(
           'Parameter `id` is required when calling `deleteABTest`.'
         );
       }
 
+      const requestPath = '/2/abtests/{id}'.replace(
+        '{id}',
+        encodeURIComponent(id)
+      );
+      const headers: Headers = {};
+      const queryParameters: QueryParameters = {};
+
       const request: Request = {
         method: 'DELETE',
         path: requestPath,
@@ -202,23 +198,19 @@ export function createAbtestingApi(
      * @summary Send requests to the Algolia REST API.
      * @param get - The get object.
      * @param get.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
-     * @param get.parameters - URL-encoded query string. Force some query parameters to be applied for each query made with this API key.
+     * @param get.parameters - Query parameters to be applied to the current query.
      */
     get(
       { path, parameters }: GetProps,
       requestOptions?: RequestOptions
     ): Promise<Record<string, any>> {
-      const requestPath = '/1{path}'.replace('{path}', String(path));
-      const headers: Headers = {};
-      const queryParameters: QueryParameters = {};
-
       if (!path) {
         throw new Error('Parameter `path` is required when calling `get`.');
       }
 
-      if (parameters !== undefined) {
-        queryParameters.parameters = parameters.toString();
-      }
+      const requestPath = '/1{path}'.replace('{path}', path);
+      const headers: Headers = {};
+      const queryParameters: QueryParameters = parameters || {};
 
       const request: Request = {
         method: 'GET',
@@ -246,17 +238,17 @@ export function createAbtestingApi(
       { id }: GetABTestProps,
       requestOptions?: RequestOptions
     ): Promise<ABTest> {
+      if (!id) {
+        throw new Error('Parameter `id` is required when calling `getABTest`.');
+      }
+
       const requestPath = '/2/abtests/{id}'.replace(
         '{id}',
-        encodeURIComponent(String(id))
+        encodeURIComponent(id)
       );
       const headers: Headers = {};
       const queryParameters: QueryParameters = {};
 
-      if (!id) {
-        throw new Error('Parameter `id` is required when calling `getABTest`.');
-      }
-
       const request: Request = {
         method: 'GET',
         path: requestPath,
@@ -317,24 +309,20 @@ export function createAbtestingApi(
      * @summary Send requests to the Algolia REST API.
      * @param post - The post object.
      * @param post.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
-     * @param post.parameters - URL-encoded query string. Force some query parameters to be applied for each query made with this API key.
+     * @param post.parameters - Query parameters to be applied to the current query.
      * @param post.body - The parameters to send with the custom request.
      */
     post(
       { path, parameters, body }: PostProps,
       requestOptions?: RequestOptions
     ): Promise<Record<string, any>> {
-      const requestPath = '/1{path}'.replace('{path}', String(path));
-      const headers: Headers = {};
-      const queryParameters: QueryParameters = {};
-
       if (!path) {
         throw new Error('Parameter `path` is required when calling `post`.');
       }
 
-      if (parameters !== undefined) {
-        queryParameters.parameters = parameters.toString();
-      }
+      const requestPath = '/1{path}'.replace('{path}', path);
+      const headers: Headers = {};
+      const queryParameters: QueryParameters = parameters || {};
 
       const request: Request = {
         method: 'POST',
@@ -358,24 +346,20 @@ export function createAbtestingApi(
      * @summary Send requests to the Algolia REST API.
      * @param put - The put object.
      * @param put.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
-     * @param put.parameters - URL-encoded query string. Force some query parameters to be applied for each query made with this API key.
+     * @param put.parameters - Query parameters to be applied to the current query.
      * @param put.body - The parameters to send with the custom request.
      */
     put(
       { path, parameters, body }: PutProps,
       requestOptions?: RequestOptions
     ): Promise<Record<string, any>> {
-      const requestPath = '/1{path}'.replace('{path}', String(path));
-      const headers: Headers = {};
-      const queryParameters: QueryParameters = {};
-
       if (!path) {
         throw new Error('Parameter `path` is required when calling `put`.');
       }
 
-      if (parameters !== undefined) {
-        queryParameters.parameters = parameters.toString();
-      }
+      const requestPath = '/1{path}'.replace('{path}', path);
+      const headers: Headers = {};
+      const queryParameters: QueryParameters = parameters || {};
 
       const request: Request = {
         method: 'PUT',
@@ -404,19 +388,19 @@ export function createAbtestingApi(
       { id }: StopABTestProps,
       requestOptions?: RequestOptions
     ): Promise<ABTestResponse> {
-      const requestPath = '/2/abtests/{id}/stop'.replace(
-        '{id}',
-        encodeURIComponent(String(id))
-      );
-      const headers: Headers = {};
-      const queryParameters: QueryParameters = {};
-
       if (!id) {
         throw new Error(
           'Parameter `id` is required when calling `stopABTest`.'
         );
       }
 
+      const requestPath = '/2/abtests/{id}/stop'.replace(
+        '{id}',
+        encodeURIComponent(id)
+      );
+      const headers: Headers = {};
+      const queryParameters: QueryParameters = {};
+
       const request: Request = {
         method: 'POST',
         path: requestPath,
@@ -442,9 +426,9 @@ export type DelProps = {
    */
   path: string;
   /**
-   * URL-encoded query string. Force some query parameters to be applied for each query made with this API key.
+   * Query parameters to be applied to the current query.
    */
-  parameters?: string;
+  parameters?: Record<string, any>;
   /**
    * The parameters to send with the custom request.
    */
@@ -464,9 +448,9 @@ export type GetProps = {
    */
   path: string;
   /**
-   * URL-encoded query string. Force some query parameters to be applied for each query made with this API key.
+   * Query parameters to be applied to the current query.
    */
-  parameters?: string;
+  parameters?: Record<string, any>;
 };
 
 export type GetABTestProps = {
@@ -493,9 +477,9 @@ export type PostProps = {
    */
   path: string;
   /**
-   * URL-encoded query string. Force some query parameters to be applied for each query made with this API key.
+   * Query parameters to be applied to the current query.
    */
-  parameters?: string;
+  parameters?: Record<string, any>;
   /**
    * The parameters to send with the custom request.
    */
@@ -508,9 +492,9 @@ export type PutProps = {
    */
   path: string;
   /**
-   * URL-encoded query string. Force some query parameters to be applied for each query made with this API key.
+   * Query parameters to be applied to the current query.
    */
-  parameters?: string;
+  parameters?: Record<string, any>;
   /**
    * The parameters to send with the custom request.
    */