@algolia/recommend 5.0.0-alpha.90 → 5.0.0-alpha.97

package/dist/src/recommendClient.d.ts

@@ -1,12 +1,12 @@
 import type { CreateClientOptions, RequestOptions } from '@algolia/client-common';
-import type { DelProps, DeleteRecommendRuleProps, GetProps, GetRecommendRuleProps, GetRecommendStatusProps, PostProps, PutProps, SearchRecommendRulesProps } from '../model/clientMethodProps';
+import type { CustomDeleteProps, CustomGetProps, CustomPostProps, CustomPutProps, DeleteRecommendRuleProps, GetRecommendRuleProps, GetRecommendStatusProps, SearchRecommendRulesProps } from '../model/clientMethodProps';
 import type { DeletedAtResponse } from '../model/deletedAtResponse';
 import type { GetRecommendTaskResponse } from '../model/getRecommendTaskResponse';
 import type { GetRecommendationsParams } from '../model/getRecommendationsParams';
 import type { GetRecommendationsResponse } from '../model/getRecommendationsResponse';
 import type { RuleResponse } from '../model/ruleResponse';
 import type { SearchRecommendRulesResponse } from '../model/searchRecommendRulesResponse';
-export declare const apiClientVersion = "5.0.0-alpha.90";
+export declare const apiClientVersion = "5.0.0-alpha.97";
 export declare function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
     transporter: import("@algolia/client-common").Transporter;
     /**
@@ -32,12 +32,44 @@ export declare function createRecommendClient({ appId: appIdOption, apiKey: apiK
      * This method allow you to send requests to the Algolia REST API.
      *
      * @summary Send requests to the Algolia REST API.
-     * @param del - The del object.
-     * @param del.path - Path of the endpoint, anything after \"/1\" must be specified.
-     * @param del.parameters - Query parameters to apply to the current query.
+     * @param customDelete - The customDelete object.
+     * @param customDelete.path - Path of the endpoint, anything after \"/1\" must be specified.
+     * @param customDelete.parameters - Query parameters to apply to the current query.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    del({ path, parameters }: DelProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
+    customDelete({ path, parameters }: CustomDeleteProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
+    /**
+     * This method allow you to send requests to the Algolia REST API.
+     *
+     * @summary Send requests to the Algolia REST API.
+     * @param customGet - The customGet object.
+     * @param customGet.path - Path of the endpoint, anything after \"/1\" must be specified.
+     * @param customGet.parameters - Query parameters to apply to the current query.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    customGet({ path, parameters }: CustomGetProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
+    /**
+     * This method allow you to send requests to the Algolia REST API.
+     *
+     * @summary Send requests to the Algolia REST API.
+     * @param customPost - The customPost object.
+     * @param customPost.path - Path of the endpoint, anything after \"/1\" must be specified.
+     * @param customPost.parameters - Query parameters to apply to the current query.
+     * @param customPost.body - Parameters to send with the custom request.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    customPost({ path, parameters, body }: CustomPostProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
+    /**
+     * This method allow you to send requests to the Algolia REST API.
+     *
+     * @summary Send requests to the Algolia REST API.
+     * @param customPut - The customPut object.
+     * @param customPut.path - Path of the endpoint, anything after \"/1\" must be specified.
+     * @param customPut.parameters - Query parameters to apply to the current query.
+     * @param customPut.body - Parameters to send with the custom request.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    customPut({ path, parameters, body }: CustomPutProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
     /**
      * Delete a [Recommend rule](https://www.algolia.com/doc/guides/algolia-recommend/how-to/rules/).
      *
@@ -49,16 +81,6 @@ export declare function createRecommendClient({ appId: appIdOption, apiKey: apiK
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     deleteRecommendRule({ indexName, model, objectID }: DeleteRecommendRuleProps, requestOptions?: RequestOptions): Promise<DeletedAtResponse>;
-    /**
-     * This method allow you to send requests to the Algolia REST API.
-     *
-     * @summary Send requests to the Algolia REST API.
-     * @param get - The get object.
-     * @param get.path - Path of the endpoint, anything after \"/1\" must be specified.
-     * @param get.parameters - Query parameters to apply to the current query.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    get({ path, parameters }: GetProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
     /**
      * Return a [Recommend rule](https://www.algolia.com/doc/guides/algolia-recommend/how-to/rules/).
      *
@@ -89,28 +111,6 @@ export declare function createRecommendClient({ appId: appIdOption, apiKey: apiK
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     getRecommendations(getRecommendationsParams: GetRecommendationsParams, requestOptions?: RequestOptions): Promise<GetRecommendationsResponse>;
-    /**
-     * This method allow you to send requests to the Algolia REST API.
-     *
-     * @summary Send requests to the Algolia REST API.
-     * @param post - The post object.
-     * @param post.path - Path of the endpoint, anything after \"/1\" must be specified.
-     * @param post.parameters - Query parameters to apply to the current query.
-     * @param post.body - Parameters to send with the custom request.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    post({ path, parameters, body }: PostProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
-    /**
-     * This method allow you to send requests to the Algolia REST API.
-     *
-     * @summary Send requests to the Algolia REST API.
-     * @param put - The put object.
-     * @param put.path - Path of the endpoint, anything after \"/1\" must be specified.
-     * @param put.parameters - Query parameters to apply to the current query.
-     * @param put.body - Parameters to send with the custom request.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    put({ path, parameters, body }: PutProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
     /**
      * List [Recommend rules](https://www.algolia.com/doc/guides/algolia-recommend/how-to/rules/).
      *

package/dist/src/recommendClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"recommendClient.d.ts","sourceRoot":"","sources":["../../src/recommendClient.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EACV,mBAAmB,EAInB,cAAc,EAEf,MAAM,wBAAwB,CAAC;AAEhC,OAAO,KAAK,EACV,QAAQ,EACR,wBAAwB,EACxB,QAAQ,EACR,qBAAqB,EACrB,uBAAuB,EACvB,SAAS,EACT,QAAQ,EACR,yBAAyB,EAC1B,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,mCAAmC,CAAC;AAClF,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,mCAAmC,CAAC;AAClF,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,qCAAqC,CAAC;AACtF,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAC1D,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,uCAAuC,CAAC;AAE1F,eAAO,MAAM,gBAAgB,mBAAmB,CAAC;AAsCjD,wBAAgB,qBAAqB,CAAC,EACpC,KAAK,EAAE,WAAW,EAClB,MAAM,EAAE,YAAY,EACpB,QAAQ,EACR,aAAa,EACb,GAAG,OAAO,EACX,EAAE,mBAAmB;;IAwBlB;;OAEG;;IAGH;;OAEG;kBACW,QAAQ,IAAI,CAAC;IAO3B;;OAEG;;IAKH;;;;;OAKG;6BACsB,MAAM,YAAY,MAAM,GAAG,IAAI;IAIxD;;;;;;;;OAQG;8BAEqB,QAAQ,mBACb,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAmB/B;;;;;;;;;OASG;wDAE+B,wBAAwB,mBACvC,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAqC7B;;;;;;;;OAQG;8BAEqB,QAAQ,mBACb,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAmB/B;;;;;;;;;OASG;qDAE+B,qBAAqB,mBACpC,cAAc,GAC9B,QAAQ,YAAY,CAAC;IAqCxB;;;;;;;;;OASG;qDAE6B,uBAAuB,mBACpC,cAAc,GAC9B,QAAQ,wBAAwB,CAAC;IAoCpC;;;;;;OAMG;iDAEyB,wBAAwB,mBACjC,cAAc,GAC9B,QAAQ,0BAA0B,CAAC;IA8BtC;;;;;;;;;OASG;qCAE2B,SAAS,mBACpB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAoB/B;;;;;;;;;OASG;oCAE2B,QAAQ,mBACnB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAoB/B;;;;;;;;;OASG;4EAME,yBAAyB,mBACX,cAAc,GAC9B,QAAQ,4BAA4B,CAAC;EAiC3C;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,UAAU,CAAC,OAAO,qBAAqB,CAAC,CAAC"}
+{"version":3,"file":"recommendClient.d.ts","sourceRoot":"","sources":["../../src/recommendClient.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EACV,mBAAmB,EAInB,cAAc,EAEf,MAAM,wBAAwB,CAAC;AAEhC,OAAO,KAAK,EACV,iBAAiB,EACjB,cAAc,EACd,eAAe,EACf,cAAc,EACd,wBAAwB,EACxB,qBAAqB,EACrB,uBAAuB,EACvB,yBAAyB,EAC1B,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,mCAAmC,CAAC;AAClF,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,mCAAmC,CAAC;AAClF,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,qCAAqC,CAAC;AACtF,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAC1D,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,uCAAuC,CAAC;AAE1F,eAAO,MAAM,gBAAgB,mBAAmB,CAAC;AAsCjD,wBAAgB,qBAAqB,CAAC,EACpC,KAAK,EAAE,WAAW,EAClB,MAAM,EAAE,YAAY,EACpB,QAAQ,EACR,aAAa,EACb,GAAG,OAAO,EACX,EAAE,mBAAmB;;IAwBlB;;OAEG;;IAGH;;OAEG;kBACW,QAAQ,IAAI,CAAC;IAO3B;;OAEG;;IAKH;;;;;OAKG;6BACsB,MAAM,YAAY,MAAM,GAAG,IAAI;IAIxD;;;;;;;;OAQG;uCAEqB,iBAAiB,mBACtB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAqB/B;;;;;;;;OAQG;oCAEqB,cAAc,mBACnB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAqB/B;;;;;;;;;OASG;2CAE2B,eAAe,mBAC1B,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAsB/B;;;;;;;;;OASG;0CAE2B,cAAc,mBACzB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAsB/B;;;;;;;;;OASG;wDAE+B,wBAAwB,mBACvC,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAqC7B;;;;;;;;;OASG;qDAE+B,qBAAqB,mBACpC,cAAc,GAC9B,QAAQ,YAAY,CAAC;IAqCxB;;;;;;;;;OASG;qDAE6B,uBAAuB,mBACpC,cAAc,GAC9B,QAAQ,wBAAwB,CAAC;IAoCpC;;;;;;OAMG;iDAEyB,wBAAwB,mBACjC,cAAc,GAC9B,QAAQ,0BAA0B,CAAC;IA8BtC;;;;;;;;;OASG;4EAME,yBAAyB,mBACX,cAAc,GAC9B,QAAQ,4BAA4B,CAAC;EAiC3C;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,UAAU,CAAC,OAAO,qBAAqB,CAAC,CAAC"}

package/model/baseRecommendedForYouQuery.ts

@@ -0,0 +1,12 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+import type { RecommendedForYouModel } from './recommendedForYouModel';
+import type { RecommendedForYouQueryParameters } from './recommendedForYouQueryParameters';
+
+export type BaseRecommendedForYouQuery = {
+  model: RecommendedForYouModel;
+
+  queryParameters?: RecommendedForYouQueryParameters;
+
+  fallbackParameters?: RecommendedForYouQueryParameters;
+};

package/model/baseRecommendedForYouQueryParameters.ts

@@ -0,0 +1,8 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+export type BaseRecommendedForYouQueryParameters = {
+  /**
+   * Associates a [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/) with the current search.
+   */
+  userToken: string;
+};

package/model/clientMethodProps.ts

@@ -4,9 +4,9 @@ import type { RecommendModels } from './recommendModels';
 import type { SearchRecommendRulesParams } from './searchRecommendRulesParams';
 
 /**
- * Properties for the `del` method.
+ * Properties for the `customDelete` method.
  */
-export type DelProps = {
+export type CustomDeleteProps = {
   /**
    * Path of the endpoint, anything after \"/1\" must be specified.
    */
@@ -18,27 +18,23 @@ export type DelProps = {
 };
 
 /**
- * Properties for the `deleteRecommendRule` method.
+ * Properties for the `customGet` method.
  */
-export type DeleteRecommendRuleProps = {
+export type CustomGetProps = {
   /**
-   * Index on which to perform the request.
-   */
-  indexName: string;
-  /**
-   * [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
+   * Path of the endpoint, anything after \"/1\" must be specified.
    */
-  model: RecommendModels;
+  path: string;
   /**
-   * Unique record (object) identifier.
+   * Query parameters to apply to the current query.
    */
-  objectID: string;
+  parameters?: Record<string, any>;
 };
 
 /**
- * Properties for the `get` method.
+ * Properties for the `customPost` method.
  */
-export type GetProps = {
+export type CustomPostProps = {
   /**
    * Path of the endpoint, anything after \"/1\" must be specified.
    */
@@ -47,30 +43,34 @@ export type GetProps = {
    * Query parameters to apply to the current query.
    */
   parameters?: Record<string, any>;
+  /**
+   * Parameters to send with the custom request.
+   */
+  body?: Record<string, any>;
 };
 
 /**
- * Properties for the `getRecommendRule` method.
+ * Properties for the `customPut` method.
  */
-export type GetRecommendRuleProps = {
+export type CustomPutProps = {
   /**
-   * Index on which to perform the request.
+   * Path of the endpoint, anything after \"/1\" must be specified.
    */
-  indexName: string;
+  path: string;
   /**
-   * [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
+   * Query parameters to apply to the current query.
    */
-  model: RecommendModels;
+  parameters?: Record<string, any>;
   /**
-   * Unique record (object) identifier.
+   * Parameters to send with the custom request.
    */
-  objectID: string;
+  body?: Record<string, any>;
 };
 
 /**
- * Properties for the `getRecommendStatus` method.
+ * Properties for the `deleteRecommendRule` method.
  */
-export type GetRecommendStatusProps = {
+export type DeleteRecommendRuleProps = {
   /**
    * Index on which to perform the request.
    */
@@ -80,45 +80,45 @@ export type GetRecommendStatusProps = {
    */
   model: RecommendModels;
   /**
-   * Unique identifier of a task. Numeric value (up to 64bits).
+   * Unique record (object) identifier.
    */
-  taskID: number;
+  objectID: string;
 };
 
 /**
- * Properties for the `post` method.
+ * Properties for the `getRecommendRule` method.
  */
-export type PostProps = {
+export type GetRecommendRuleProps = {
   /**
-   * Path of the endpoint, anything after \"/1\" must be specified.
+   * Index on which to perform the request.
    */
-  path: string;
+  indexName: string;
   /**
-   * Query parameters to apply to the current query.
+   * [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
    */
-  parameters?: Record<string, any>;
+  model: RecommendModels;
   /**
-   * Parameters to send with the custom request.
+   * Unique record (object) identifier.
    */
-  body?: Record<string, any>;
+  objectID: string;
 };
 
 /**
- * Properties for the `put` method.
+ * Properties for the `getRecommendStatus` method.
  */
-export type PutProps = {
+export type GetRecommendStatusProps = {
   /**
-   * Path of the endpoint, anything after \"/1\" must be specified.
+   * Index on which to perform the request.
    */
-  path: string;
+  indexName: string;
   /**
-   * Query parameters to apply to the current query.
+   * [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
    */
-  parameters?: Record<string, any>;
+  model: RecommendModels;
   /**
-   * Parameters to send with the custom request.
+   * Unique identifier of a task. Numeric value (up to 64bits).
    */
-  body?: Record<string, any>;
+  taskID: number;
 };
 
 /**

package/model/getRecommendationsResponse.ts

@@ -1,7 +1,7 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
-import type { RecommendationsResponse } from './recommendationsResponse';
+import type { RecommendationsResults } from './recommendationsResults';
 
 export type GetRecommendationsResponse = {
-  results?: RecommendationsResponse[];
+  results?: RecommendationsResults[];
 };

package/model/highlightResult.ts

@@ -2,4 +2,6 @@
 
 import type { HighlightResultOption } from './highlightResultOption';
 
-export type HighlightResult = HighlightResultOption | HighlightResultOption[];
+export type HighlightResult =
+  | HighlightResultOption
+  | Record<string, HighlightResultOption>;

package/model/index.ts

@@ -11,6 +11,8 @@ export * from './automaticFacetFilter';
 export * from './automaticFacetFilters';
 export * from './baseRecommendRequest';
 export * from './baseRecommendationsQuery';
+export * from './baseRecommendedForYouQuery';
+export * from './baseRecommendedForYouQueryParameters';
 export * from './baseSearchParams';
 export * from './baseSearchParamsWithoutQuery';
 export * from './baseSearchResponse';
@@ -55,12 +57,16 @@ export * from './queryType';
 export * from './rankingInfo';
 export * from './reRankingApplyFilter';
 export * from './recommendHit';
-export * from './recommendHits';
 export * from './recommendModels';
 export * from './recommendationModels';
+export * from './recommendationsHit';
+export * from './recommendationsHits';
 export * from './recommendationsQuery';
 export * from './recommendationsRequest';
-export * from './recommendationsResponse';
+export * from './recommendationsResults';
+export * from './recommendedForYouModel';
+export * from './recommendedForYouQuery';
+export * from './recommendedForYouQueryParameters';
 export * from './redirect';
 export * from './redirectRuleIndexMetadata';
 export * from './redirectRuleIndexMetadataData';
@@ -79,6 +85,7 @@ export * from './snippetResultOption';
 export * from './sortRemainingBy';
 export * from './tagFilters';
 export * from './taskStatus';
+export * from './trendingFacetHit';
 export * from './trendingFacetsModel';
 export * from './trendingFacetsQuery';
 export * from './trendingItemsModel';

package/model/recommendationsHit.ts

@@ -0,0 +1,6 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+import type { RecommendHit } from './recommendHit';
+import type { TrendingFacetHit } from './trendingFacetHit';
+
+export type RecommendationsHit = RecommendHit | TrendingFacetHit;

package/model/{recommendHits.ts → recommendationsHits.ts}

@@ -1,9 +1,9 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
-import type { RecommendHit } from './recommendHit';
+import type { RecommendationsHit } from './recommendationsHit';
 
-export type RecommendHits = {
-  hits: RecommendHit[];
+export type RecommendationsHits = {
+  hits: RecommendationsHit[];
 
   /**
    * Text to search for in an index.

package/model/recommendationsRequest.ts

@@ -1,10 +1,12 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 import type { RecommendationsQuery } from './recommendationsQuery';
+import type { RecommendedForYouQuery } from './recommendedForYouQuery';
 import type { TrendingFacetsQuery } from './trendingFacetsQuery';
 import type { TrendingItemsQuery } from './trendingItemsQuery';
 
 export type RecommendationsRequest =
   | RecommendationsQuery
+  | RecommendedForYouQuery
   | TrendingFacetsQuery
   | TrendingItemsQuery;

package/model/{recommendationsResponse.ts → recommendationsResults.ts}

@@ -1,6 +1,6 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 import type { BaseSearchResponse } from './baseSearchResponse';
-import type { RecommendHits } from './recommendHits';
+import type { RecommendationsHits } from './recommendationsHits';
 
-export type RecommendationsResponse = BaseSearchResponse & RecommendHits;
+export type RecommendationsResults = BaseSearchResponse & RecommendationsHits;

package/model/recommendedForYouModel.ts

@@ -0,0 +1,6 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+/**
+ * Recommended for you model.
+ */
+export type RecommendedForYouModel = 'recommended-for-you';

package/model/recommendedForYouQuery.ts

@@ -0,0 +1,7 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+import type { BaseRecommendRequest } from './baseRecommendRequest';
+import type { BaseRecommendedForYouQuery } from './baseRecommendedForYouQuery';
+
+export type RecommendedForYouQuery = BaseRecommendedForYouQuery &
+  BaseRecommendRequest;

package/model/recommendedForYouQueryParameters.ts

@@ -0,0 +1,7 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+import type { BaseRecommendedForYouQueryParameters } from './baseRecommendedForYouQueryParameters';
+import type { SearchParamsObject } from './searchParamsObject';
+
+export type RecommendedForYouQueryParameters =
+  BaseRecommendedForYouQueryParameters & SearchParamsObject;

package/model/searchRecommendRulesParams.ts

@@ -28,9 +28,4 @@ export type SearchRecommendRulesParams = {
    * Restricts responses to enabled rules. When absent (default), _all_ rules are retrieved.
    */
   enabled?: boolean | null;
-
-  /**
-   * Request options to send with the API call.
-   */
-  _requestOptions?: Array<Record<string, any>>;
 };

package/model/searchRecommendRulesResponse.ts

@@ -9,17 +9,17 @@ export type SearchRecommendRulesResponse = {
   hits: RuleResponse[];
 
   /**
-   * Number of fetched rules.
+   * Number of hits the search query matched.
    */
   nbHits: number;
 
   /**
-   * Current page.
+   * Page to retrieve (the first page is `0`, not `1`).
    */
   page: number;
 
   /**
-   * Number of pages.
+   * Number of pages of results for the current query.
    */
   nbPages: number;
 };

package/model/snippetResult.ts

@@ -2,4 +2,6 @@
 
 import type { SnippetResultOption } from './snippetResultOption';
 
-export type SnippetResult = SnippetResultOption | SnippetResultOption[];
+export type SnippetResult =
+  | Record<string, SnippetResultOption>
+  | SnippetResultOption;

package/model/trendingFacetHit.ts

@@ -0,0 +1,21 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+/**
+ * Trending facet hit.
+ */
+export type TrendingFacetHit = {
+  /**
+   * Recommendation score.
+   */
+  _score: number;
+
+  /**
+   * Facet name for trending models.
+   */
+  facetName: string;
+
+  /**
+   * Facet value for trending models.
+   */
+  facetValue: string;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@algolia/recommend",
-  "version": "5.0.0-alpha.90",
+  "version": "5.0.0-alpha.97",
   "description": "JavaScript client for recommend",
   "repository": "algolia/algoliasearch-client-javascript",
   "license": "MIT",
@@ -39,14 +39,14 @@
     "clean": "rm -rf ./dist || true"
   },
   "dependencies": {
-    "@algolia/client-common": "5.0.0-alpha.91",
-    "@algolia/requester-browser-xhr": "5.0.0-alpha.91",
-    "@algolia/requester-node-http": "5.0.0-alpha.91"
+    "@algolia/client-common": "5.0.0-alpha.98",
+    "@algolia/requester-browser-xhr": "5.0.0-alpha.98",
+    "@algolia/requester-node-http": "5.0.0-alpha.98"
   },
   "devDependencies": {
-    "@types/node": "20.8.10",
-    "rollup": "4.3.0",
-    "typescript": "5.2.2"
+    "@types/node": "20.11.1",
+    "rollup": "4.9.5",
+    "typescript": "5.3.3"
   },
   "engines": {
     "node": ">= 14.0.0"

package/dist/model/recommendHits.d.ts

@@ -1,13 +0,0 @@
-import type { RecommendHit } from './recommendHit';
-export type RecommendHits = {
-    hits: RecommendHit[];
-    /**
-     * Text to search for in an index.
-     */
-    query?: string;
-    /**
-     * URL-encoded string of all search parameters.
-     */
-    params?: string;
-};
-//# sourceMappingURL=recommendHits.d.ts.map

package/dist/model/recommendHits.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"recommendHits.d.ts","sourceRoot":"","sources":["../../model/recommendHits.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEnD,MAAM,MAAM,aAAa,GAAG;IAC1B,IAAI,EAAE,YAAY,EAAE,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC"}

package/dist/model/recommendationsResponse.d.ts

@@ -1,4 +0,0 @@
-import type { BaseSearchResponse } from './baseSearchResponse';
-import type { RecommendHits } from './recommendHits';
-export type RecommendationsResponse = BaseSearchResponse & RecommendHits;
-//# sourceMappingURL=recommendationsResponse.d.ts.map

package/dist/model/recommendationsResponse.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"recommendationsResponse.d.ts","sourceRoot":"","sources":["../../model/recommendationsResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAErD,MAAM,MAAM,uBAAuB,GAAG,kBAAkB,GAAG,aAAa,CAAC"}