feat: wrap parameters for all methods

Author: shortcuts

clients/algoliasearch-client-javascript/client-analytics/src/analyticsApi.ts

@@ -85,9 +85,12 @@ export class PersonalizationApi {
    * Returns, as part of the response, a date until which the data can safely be considered as deleted for the given user. This means that if you send events for the given user before this date, they will be ignored. Any data received after the deletedUntil date will start building a new user profile. It might take a couple hours before for the deletion request to be fully processed.
    *
    * @summary Delete the user profile and all its associated data.
-   * @param userToken - UserToken representing the user for which to fetch the Personalization profile.
+   * @param deleteUserProfile - The deleteUserProfile parameters.
+   * @param deleteUserProfile.userToken - UserToken representing the user for which to fetch the Personalization profile.
    */
-  deleteUserProfile(userToken: string): Promise<DeleteUserProfileResponse> {
+  deleteUserProfile({
+    userToken,
+  }: DeleteUserProfileProps): Promise<DeleteUserProfileResponse> {
     const path = '/1/profiles/{userToken}'.replace(
       '{userToken}',
       encodeURIComponent(String(userToken))
@@ -117,6 +120,7 @@ export class PersonalizationApi {
    * The strategy contains information on the events and facets that impact user profiles and personalized search results.
    *
    * @summary Get the current personalization strategy.
+   * @param getPersonalizationStrategy - The getPersonalizationStrategy parameters.
    */
   getPersonalizationStrategy(): Promise<PersonalizationStrategyObject> {
     const path = '/1/strategies/personalization';
@@ -139,9 +143,12 @@ export class PersonalizationApi {
    * The profile is structured by facet name used in the strategy. Each facet value is mapped to its score. Each score represents the user affinity for a specific facet value given the userToken past events and the Personalization strategy defined. Scores are bounded to 20. The last processed event timestamp is provided using the ISO 8601 format for debugging purposes.
    *
    * @summary Get the user profile built from Personalization strategy.
-   * @param userToken - UserToken representing the user for which to fetch the Personalization profile.
+   * @param getUserTokenProfile - The getUserTokenProfile parameters.
+   * @param getUserTokenProfile.userToken - UserToken representing the user for which to fetch the Personalization profile.
    */
-  getUserTokenProfile(userToken: string): Promise<GetUserTokenResponse> {
+  getUserTokenProfile({
+    userToken,
+  }: GetUserTokenProfileProps): Promise<GetUserTokenResponse> {
     const path = '/1/profiles/personalization/{userToken}'.replace(
       '{userToken}',
       encodeURIComponent(String(userToken))
@@ -171,11 +178,12 @@ export class PersonalizationApi {
    * A strategy defines the events and facets that impact user profiles and personalized search results.
    *
    * @summary Set a new personalization strategy.
-   * @param personalizationStrategyObject - The personalizationStrategyObject.
+   * @param setPersonalizationStrategy - The setPersonalizationStrategy parameters.
+   * @param setPersonalizationStrategy.personalizationStrategyObject - The personalizationStrategyObject.
    */
-  setPersonalizationStrategy(
-    personalizationStrategyObject: PersonalizationStrategyObject
-  ): Promise<SetPersonalizationStrategyResponse> {
+  setPersonalizationStrategy({
+    personalizationStrategyObject,
+  }: SetPersonalizationStrategyProps): Promise<SetPersonalizationStrategyResponse> {
     const path = '/1/strategies/personalization';
     const headers: Headers = { Accept: 'application/json' };
     const queryParameters: Record<string, string> = {};
@@ -203,3 +211,15 @@ export class PersonalizationApi {
     return this.sendRequest(request, requestOptions);
   }
 }
+
+export type DeleteUserProfileProps = {
+  userToken: string;
+};
+
+export type GetUserTokenProfileProps = {
+  userToken: string;
+};
+
+export type SetPersonalizationStrategyProps = {
+  personalizationStrategyObject: PersonalizationStrategyObject;
+};

clients/algoliasearch-client-javascript/client-personalization/src/personalizationApi.ts

@@ -64,7 +64,7 @@ export type BaseSearchParams = {
    */
   aroundLatLng?: string;
   /**
-   * Search for entries around a given location automatically computed from the requester’s IP address.
+   * Search for entries around a given location automatically computed from the requester\'s IP address.
    */
   aroundLatLngViaIP?: boolean;
   /**

clients/algoliasearch-client-javascript/client-search/src/searchApi.ts

@@ -46,7 +46,7 @@ export type BaseSearchResponse = {
    */
   index?: string;
   /**
-   * Index name used for the query. In the case of an A/B test, the targeted index isn’t always the index used by the query.
+   * Index name used for the query. In the case of an A/B test, the targeted index isn\'t always the index used by the query.
    */
   indexUsed?: string;
   /**

clients/algoliasearch-client-javascript/recommend/model/baseSearchParams.ts

@@ -8,7 +8,7 @@ export type IndexSettingsAsSearchParams = {
    */
   attributesForFaceting?: string[];
   /**
-   * List of attributes that can’t be retrieved at query time.
+   * List of attributes that can\'t be retrieved at query time.
    */
   unretrievableAttributes?: string[];
   /**
@@ -28,7 +28,7 @@ export type IndexSettingsAsSearchParams = {
    */
   customRanking?: string[];
   /**
-   * Controls the relevancy threshold below which less relevant results aren’t included in the results.
+   * Controls the relevancy threshold below which less relevant results aren\'t included in the results.
    */
   relevancyStrictness?: number;
   /**
@@ -72,7 +72,7 @@ export type IndexSettingsAsSearchParams = {
    */
   typoTolerance?: IndexSettingsAsSearchParams.TypoToleranceEnum;
   /**
-   * Whether to allow typos on numbers (“numeric tokens”) in the query string.
+   * Whether to allow typos on numbers (\"numeric tokens\") in the query string.
    */
   allowTyposOnNumericTokens?: boolean;
   /**
@@ -92,7 +92,7 @@ export type IndexSettingsAsSearchParams = {
    */
   removeStopWords?: string;
   /**
-   * List of characters that the engine shouldn’t automatically normalize.
+   * List of characters that the engine shouldn\'t automatically normalize.
    */
   keepDiacriticsOnCharacters?: string;
   /**
@@ -116,7 +116,7 @@ export type IndexSettingsAsSearchParams = {
    */
   queryType?: IndexSettingsAsSearchParams.QueryTypeEnum;
   /**
-   * Selects a strategy to remove words from the query when it doesn’t match any hits.
+   * Selects a strategy to remove words from the query when it doesn\'t match any hits.
    */
   removeWordsIfNoResults?: IndexSettingsAsSearchParams.RemoveWordsIfNoResultsEnum;
   /**
@@ -140,15 +140,15 @@ export type IndexSettingsAsSearchParams = {
    */
   alternativesAsExact?: IndexSettingsAsSearchParams.AlternativesAsExactEnum[];
   /**
-   * Allows you to specify which advanced syntax features are active when ‘advancedSyntax’ is enabled.
+   * Allows you to specify which advanced syntax features are active when ‘advancedSyntax\' is enabled.
    */
   advancedSyntaxFeatures?: IndexSettingsAsSearchParams.AdvancedSyntaxFeaturesEnum[];
   /**
    * Enables de-duplication or grouping of results.
    */
   distinct?: number;
   /**
-   * Whether to take into account an index’s synonyms for a particular search.
+   * Whether to take into account an index\'s synonyms for a particular search.
    */
   synonyms?: boolean;
   /**
@@ -164,7 +164,7 @@ export type IndexSettingsAsSearchParams = {
    */
   responseFields?: string[];
   /**
-   * Maximum number of facet hits to return during a search for facet values.
+   * Maximum number of facet hits to return during a search for facet values. For performance reasons, the maximum allowed number of returned values is 100.
    */
   maxFacetHits?: number;
   /**

clients/algoliasearch-client-javascript/recommend/model/baseSearchResponse.ts

@@ -19,7 +19,7 @@ export type RecommendationRequest = {
    */
   threshold: number;
   /**
-   * The max number of recommendations to retrieve. If it’s set to 0, all the recommendations of the objectID may be returned.
+   * The max number of recommendations to retrieve. If it\'s set to 0, all the recommendations of the objectID may be returned.
    */
   maxRecommendations?: number;
   /**

clients/algoliasearch-client-javascript/recommend/model/indexSettingsAsSearchParams.ts

@@ -99,11 +99,12 @@ export class RecommendApi {
   /**
    * Returns recommendations for a specific model and objectID.
    *
-   * @param getRecommendations - The getRecommendations.
+   * @param getRecommendations - The getRecommendations parameters.
+   * @param getRecommendations.getRecommendations - The getRecommendations.
    */
-  getRecommendations(
-    getRecommendations: GetRecommendations
-  ): Promise<GetRecommendationsResponse> {
+  getRecommendations({
+    getRecommendations,
+  }: GetRecommendationsProps): Promise<GetRecommendationsResponse> {
     const path = '/1/indexes/*/recommendations';
     const headers: Headers = { Accept: 'application/json' };
     const queryParameters: Record<string, string> = {};
@@ -128,3 +129,7 @@ export class RecommendApi {
     return this.sendRequest(request, requestOptions);
   }
 }
+
+export type GetRecommendationsProps = {
+  getRecommendations: GetRecommendations;
+};

clients/algoliasearch-client-javascript/recommend/model/recommendationRequest.ts

@@ -14,7 +14,9 @@ const client = new AnalyticsApi(appId, apiKey, 'de');
 
 async function testAnalytics() {
   try {
-    const res = await client.getSearchesNoResults({ index: analyticsIndex });
+    const res = await client.getSearchesNoResults({
+      index: analyticsIndex,
+    });
 
     console.log(`[OK]`, res);
   } catch (e) {

clients/algoliasearch-client-javascript/recommend/src/recommendApi.ts

@@ -1,4 +1,8 @@
-import { RecommendApi, ApiError, RecommendationRequest } from '@algolia/recommend';
+import {
+  RecommendApi,
+  ApiError,
+  RecommendationRequest,
+} from '@algolia/recommend';
 import dotenv from 'dotenv';
 
 dotenv.config({ path: '../.env' });
@@ -15,14 +19,16 @@ const client = new RecommendApi(appId, apiKey);
 async function testRecommend() {
   try {
     const res = await client.getRecommendations({
-      requests: [
-        {
-          indexName: searchIndex,
-          model: RecommendationRequest.ModelEnum['BoughtTogether'],
-          objectID: searchQuery,
-          threshold: 0,
-        },
-      ],
+      getRecommendations: {
+        requests: [
+          {
+            indexName: searchIndex,
+            model: RecommendationRequest.ModelEnum['BoughtTogether'],
+            objectID: searchQuery,
+            threshold: 0,
+          },
+        ],
+      },
     });
 
     console.log(`[OK]`, res);

playground/javascript/analytics.ts

@@ -14,7 +14,10 @@ const client = new SearchApi(appId, apiKey);
 
 async function testSearch() {
   try {
-    const res = await client.search(searchIndex, { query: searchQuery });
+    const res = await client.search({
+      indexName: searchIndex,
+      searchParamsAsStringSearchParams: { query: searchQuery },
+    });
 
     console.log(`[OK]`, res);
   } catch (e) {

playground/javascript/recommend.ts

@@ -16,6 +16,7 @@ import { ApiKeyAuth } from '../model/models';
 * {{&description}}
 */
 {{/description}}
+
 export enum {{classname}}Keys {
   {{#authMethods}}
   {{#isApiKey}}
@@ -132,39 +133,19 @@ export class {{classname}} {
   {{#summary}}
   * @summary {{&summary}}
   {{/summary}}
-  {{! We group parameters under an object if there are more than 5}}
-  {{^allParams.5}}
-    {{#allParams}}
-    * @param {{paramName}} {{^description}}The {{paramName}}{{/description}}{{#description}}{{{description}}}{{/description}}
-    {{/allParams}}
-  {{/allParams.5}}
-  {{#allParams.5}}
-    * @param {{nickname}} - The {{nickname}} parameters.
-    {{#allParams}}
-    * @param {{nickname}}.{{paramName}} {{^description}}The {{paramName}}{{/description}}{{#description}}{{{description}}}{{/description}}
-    {{/allParams}}
-  {{/allParams.5}}
+  * @param {{nickname}} - The {{nickname}} parameters.
+  {{#allParams}}
+  * @param {{nickname}}.{{paramName}} {{^description}}The {{paramName}}{{/description}}{{#description}}{{{description}}}{{/description}}
+  {{/allParams}}
   */
   public {{nickname}} (
-        {{! We group parameters under an object if there are more than 5}}
-        {{^allParams.5}}
+      {{#allParams.0}}
+        {
             {{#allParams}}
-              {{paramName}}{{^required}}?{{/required}}: {{{dataType}}},
+              {{paramName}},
             {{/allParams}}
-        {{/allParams.5}}
-
-        {{#allParams.5}}
-            {
-                {{#allParams}}
-                  {{paramName}},
-                {{/allParams}}
-            }:
-            {
-                {{#allParams}}
-                  {{paramName}}{{^required}}?{{/required}}: {{{dataType}}},
-                {{/allParams}}
-            }
-        {{/allParams.5}}
+        }: {{#lambda.titlecase}}{{nickname}}{{/lambda.titlecase}}Props
+      {{/allParams.0}}
       ) : Promise<{{{returnType}}}> {
     const path = '{{{path}}}'{{#pathParams}}.replace(
     {{=<% %>=}}
@@ -210,4 +191,16 @@ export class {{classname}} {
   }
   {{/operation}}
 }
+
+{{#operation}}
+{{#allParams.0}}
+export type {{#lambda.titlecase}}{{nickname}}{{/lambda.titlecase}}Props = {
+  {{#allParams}}
+    {{paramName}}{{^required}}?{{/required}}: {{{dataType}}};
+  {{/allParams}}
+}
+{{/allParams.0}}
+
+{{/operation}}
+
 {{/operations}}