algoliasearch 5.0.0-beta.4 → 5.0.0-beta.6

package/dist/recommend/model/typoToleranceEnum.d.ts

@@ -0,0 +1,5 @@
+/**
+ * - `min`. Return matches with the lowest number of typos.   For example, if you have matches without typos, only include those.   But if there are no matches without typos (with 1 typo), include matches with 1 typo (2 typos). - `strict`. Return matches with the two lowest numbers of typos.   With `strict`, the Typo ranking criterion is applied first in the `ranking` setting.
+ */
+export type TypoToleranceEnum = 'min' | 'strict';
+//# sourceMappingURL=typoToleranceEnum.d.ts.map

package/dist/recommend/model/typoToleranceEnum.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"typoToleranceEnum.d.ts","sourceRoot":"","sources":["../../../../recommend/model/typoToleranceEnum.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,KAAK,GAAG,QAAQ,CAAC"}

package/dist/recommend/model/value.d.ts

@@ -0,0 +1,13 @@
+import type { SortRemainingBy } from './sortRemainingBy';
+export type Value = {
+    /**
+     * Explicit order of facets or facet values.  This setting lets you always show specific facets or facet values at the top of the list.
+     */
+    order?: string[];
+    sortRemainingBy?: SortRemainingBy;
+    /**
+     * Hide facet values.
+     */
+    hide?: string[];
+};
+//# sourceMappingURL=value.d.ts.map

package/dist/recommend/model/value.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"value.d.ts","sourceRoot":"","sources":["../../../../recommend/model/value.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD,MAAM,MAAM,KAAK,GAAG;IAClB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IAEjB,eAAe,CAAC,EAAE,eAAe,CAAC;IAElC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACjB,CAAC"}

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

@@ -0,0 +1,132 @@
+import type { CreateClientOptions, RequestOptions } from '@algolia/client-common';
+import type { CustomDeleteProps, CustomGetProps, CustomPostProps, CustomPutProps, DeleteRecommendRuleProps, GetRecommendRuleProps, GetRecommendStatusProps, LegacyGetRecommendationsParams, 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 { RecommendRule } from '../model/recommendRule';
+import type { SearchRecommendRulesResponse } from '../model/searchRecommendRulesResponse';
+export declare const apiClientVersion = "5.0.0-beta.6";
+export declare function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
+    transporter: import("@algolia/client-common").Transporter;
+    /**
+     * The `appId` currently in use.
+     */
+    appId: string;
+    /**
+     * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
+     */
+    clearCache(): Promise<void>;
+    /**
+     * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
+     */
+    readonly _ua: string;
+    /**
+     * Adds a `segment` to the `x-algolia-agent` sent with every requests.
+     *
+     * @param segment - The algolia agent (user-agent) segment to add.
+     * @param version - The version of the agent.
+     */
+    addAlgoliaAgent(segment: string, version?: string): void;
+    /**
+     * This method allow you to send requests to the Algolia REST API.
+     *
+     * @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.
+     */
+    customDelete({ path, parameters }: CustomDeleteProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
+    /**
+     * This method allow you to 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.
+     *
+     * @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.
+     *
+     * @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>>;
+    /**
+     * Deletes a Recommend rule from a recommendation scenario.
+     *
+     * Required API Key ACLs:
+     * - editSettings.
+     *
+     * @param deleteRecommendRule - The deleteRecommendRule object.
+     * @param deleteRecommendRule.indexName - Name of the index on which to perform the operation.
+     * @param deleteRecommendRule.model - [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
+     * @param deleteRecommendRule.objectID - Unique record identifier.
+     * @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>;
+    /**
+     * Retrieves a Recommend rule that you previously created in the Algolia dashboard.
+     *
+     * Required API Key ACLs:
+     * - settings.
+     *
+     * @param getRecommendRule - The getRecommendRule object.
+     * @param getRecommendRule.indexName - Name of the index on which to perform the operation.
+     * @param getRecommendRule.model - [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
+     * @param getRecommendRule.objectID - Unique record identifier.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    getRecommendRule({ indexName, model, objectID }: GetRecommendRuleProps, requestOptions?: RequestOptions): Promise<RecommendRule>;
+    /**
+     * Checks the status of a given task.  Deleting a Recommend rule is asynchronous. When you delete a rule, a task is created on a queue and completed depending on the load on the server. The API response includes a task ID that you can use to check the status.
+     *
+     * Required API Key ACLs:
+     * - editSettings.
+     *
+     * @param getRecommendStatus - The getRecommendStatus object.
+     * @param getRecommendStatus.indexName - Name of the index on which to perform the operation.
+     * @param getRecommendStatus.model - [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
+     * @param getRecommendStatus.taskID - Unique task identifier.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    getRecommendStatus({ indexName, model, taskID }: GetRecommendStatusProps, requestOptions?: RequestOptions): Promise<GetRecommendTaskResponse>;
+    /**
+     * Retrieves recommendations from selected AI models.
+     *
+     * Required API Key ACLs:
+     * - search.
+     *
+     * @param getRecommendationsParams - The getRecommendationsParams object.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    getRecommendations(getRecommendationsParams: GetRecommendationsParams | LegacyGetRecommendationsParams, requestOptions?: RequestOptions): Promise<GetRecommendationsResponse>;
+    /**
+     * Searches for Recommend rules.  Use an empty query to list all rules for this recommendation scenario.
+     *
+     * Required API Key ACLs:
+     * - settings.
+     *
+     * @param searchRecommendRules - The searchRecommendRules object.
+     * @param searchRecommendRules.indexName - Name of the index on which to perform the operation.
+     * @param searchRecommendRules.model - [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
+     * @param searchRecommendRules.searchRecommendRulesParams - The searchRecommendRulesParams object.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    searchRecommendRules({ indexName, model, searchRecommendRulesParams, }: SearchRecommendRulesProps, requestOptions?: RequestOptions): Promise<SearchRecommendRulesResponse>;
+};
+//# sourceMappingURL=recommendClient.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"recommendClient.d.ts","sourceRoot":"","sources":["../../../../recommend/src/recommendClient.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EACV,mBAAmB,EAKnB,cAAc,EACf,MAAM,wBAAwB,CAAC;AAEhC,OAAO,KAAK,EACV,iBAAiB,EACjB,cAAc,EACd,eAAe,EACf,cAAc,EACd,wBAAwB,EACxB,qBAAqB,EACrB,uBAAuB,EACvB,8BAA8B,EAC9B,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,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAC5D,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,uCAAuC,CAAC;AAE1F,eAAO,MAAM,gBAAgB,iBAAiB,CAAC;AAsC/C,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,OAAO,CAAC,IAAI,CAAC;IAO3B;;OAEG;;IAKH;;;;;OAKG;6BACsB,MAAM,YAAY,MAAM,GAAG,IAAI;IAIxD;;;;;;;OAOG;uCAEqB,iBAAiB,mBACtB,cAAc,GAC9B,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAqB/B;;;;;;;OAOG;oCAEqB,cAAc,mBACnB,cAAc,GAC9B,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAqB/B;;;;;;;;OAQG;2CAE2B,eAAe,mBAC1B,cAAc,GAC9B,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAsB/B;;;;;;;;OAQG;0CAE2B,cAAc,mBACzB,cAAc,GAC9B,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAsB/B;;;;;;;;;;;OAWG;wDAE+B,wBAAwB,mBACvC,cAAc,GAC9B,OAAO,CAAC,iBAAiB,CAAC;IAqC7B;;;;;;;;;;;OAWG;qDAE+B,qBAAqB,mBACpC,cAAc,GAC9B,OAAO,CAAC,aAAa,CAAC;IAqCzB;;;;;;;;;;;OAWG;qDAE6B,uBAAuB,mBACpC,cAAc,GAC9B,OAAO,CAAC,wBAAwB,CAAC;IAoCpC;;;;;;;;OAQG;iDAGG,wBAAwB,GACxB,8BAA8B,mBACjB,cAAc,GAC9B,OAAO,CAAC,0BAA0B,CAAC;IAuCtC;;;;;;;;;;;OAWG;4EAME,yBAAyB,mBACX,cAAc,GAC9B,OAAO,CAAC,4BAA4B,CAAC;EAiC3C"}

package/lite/model/baseIndexSettings.ts

@@ -74,9 +74,9 @@ export type BaseIndexSettings = {
   searchableAttributes?: string[];
 
   /**
-   * An object with custom data.  You can store up to 32 kB as custom data.
+   * An object with custom data.  You can store up to 32kB as custom data.
    */
-  userData?: any | null;
+  userData?: Record<string, any>;
 
   /**
    * Characters and their normalized replacements. This overrides Algolia\'s default [normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/).

package/lite/model/baseRecommendRequest.ts

@@ -0,0 +1,22 @@
+// 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 { SearchParams } from './searchParams';
+
+export type BaseRecommendRequest = {
+  /**
+   * Index name (case-sensitive).
+   */
+  indexName: string;
+
+  /**
+   * Minimum score a recommendation must have to be included in the response.
+   */
+  threshold: number;
+
+  /**
+   * Maximum number of recommendations to retrieve. By default, all recommendations are returned and no fallback request is made. Depending on the available recommendations and the other request parameters, the actual number of recommendations may be lower than this value.
+   */
+  maxRecommendations?: number;
+
+  queryParameters?: SearchParams;
+};

package/lite/model/baseSearchResponse.ts

@@ -128,9 +128,9 @@ export type BaseSearchResponse = Record<string, any> & {
   serverUsed?: string;
 
   /**
-   * An object with custom data.  You can store up to 32&nbsp;kB as custom data.
+   * An object with custom data.  You can store up to 32kB as custom data.
    */
-  userData?: any | null;
+  userData?: Record<string, any>;
 
   /**
    * Unique identifier for the query. This is used for [click analytics](https://www.algolia.com/doc/guides/analytics/click-analytics/).

package/lite/model/boughtTogetherQuery.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 { FrequentlyBoughtTogether } from './frequentlyBoughtTogether';
+
+export type BoughtTogetherQuery = BaseRecommendRequest &
+  FrequentlyBoughtTogether;

package/lite/model/clientMethodProps.ts

@@ -1,5 +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 { RecommendationsRequest } from './recommendationsRequest';
 import type { SearchForFacetsOptions } from './searchForFacetsOptions';
 import type { SearchForHitsOptions } from './searchForHitsOptions';
 import type { SearchParamsObject } from './searchParamsObject';
@@ -22,6 +23,13 @@ export type CustomPostProps = {
   body?: Record<string, any>;
 };
 
+/**
+ * Recommend method signature compatible with the `algoliasearch` v4 package. When using this signature, extra computation will be required to make it match the new signature.
+ *
+ * @deprecated This signature will be removed from the next major version, we recommend using the `GetRecommendationsParams` type for performances and future proof reasons.
+ */
+export type LegacyGetRecommendationsParams = RecommendationsRequest[];
+
 /**
  * In v4, the search parameters are wrapped in a `params` parameter.
  *

package/lite/model/fallbackParams.ts

@@ -0,0 +1,5 @@
+// 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 { SearchParamsObject } from './searchParamsObject';
+
+export type FallbackParams = Record<string, any> & SearchParamsObject;

package/lite/model/fbtModel.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.
+
+/**
+ * Frequently bought together model.  This model recommends items that have been purchased within 1 day with the item with the ID `objectID`.
+ */
+export type FbtModel = 'bought-together';

package/lite/model/frequentlyBoughtTogether.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 { FbtModel } from './fbtModel';
+
+export type FrequentlyBoughtTogether = {
+  model: FbtModel;
+
+  /**
+   * Unique record identifier.
+   */
+  objectID: string;
+};

package/lite/model/getRecommendationsParams.ts

@@ -0,0 +1,13 @@
+// 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 { RecommendationsRequest } from './recommendationsRequest';
+
+/**
+ * Recommend request body.
+ */
+export type GetRecommendationsParams = {
+  /**
+   * Recommendation request with parameters depending on the requested model.
+   */
+  requests: RecommendationsRequest[];
+};

package/lite/model/getRecommendationsResponse.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 { RecommendationsResults } from './recommendationsResults';
+
+export type GetRecommendationsResponse = {
+  results?: RecommendationsResults[];
+};

package/lite/model/index.ts

@@ -12,9 +12,11 @@ export * from './automaticFacetFilter';
 export * from './automaticFacetFilters';
 export * from './baseGetApiKeyResponse';
 export * from './baseIndexSettings';
+export * from './baseRecommendRequest';
 export * from './baseSearchParams';
 export * from './baseSearchParamsWithoutQuery';
 export * from './baseSearchResponse';
+export * from './boughtTogetherQuery';
 export * from './browseParamsObject';
 export * from './browseResponse';
 export * from './consequenceParams';
@@ -32,13 +34,21 @@ export * from './facetHits';
 export * from './facetOrdering';
 export * from './facets';
 export * from './facetsStats';
+export * from './fallbackParams';
+export * from './fbtModel';
+export * from './frequentlyBoughtTogether';
 export * from './getApiKeyResponse';
+export * from './getRecommendationsParams';
+export * from './getRecommendationsResponse';
 export * from './highlightResult';
 export * from './highlightResultOption';
 export * from './hit';
 export * from './ignorePlurals';
 export * from './indexSettings';
 export * from './indexSettingsAsSearchParams';
+export * from './lookingSimilar';
+export * from './lookingSimilarModel';
+export * from './lookingSimilarQuery';
 export * from './matchLevel';
 export * from './matchedGeoLocation';
 export * from './mode';
@@ -49,9 +59,20 @@ export * from './personalization';
 export * from './queryType';
 export * from './rankingInfo';
 export * from './reRankingApplyFilter';
+export * from './recommendHit';
+export * from './recommendationsHit';
+export * from './recommendationsHits';
+export * from './recommendationsRequest';
+export * from './recommendationsResults';
+export * from './recommendedForYou';
+export * from './recommendedForYouModel';
+export * from './recommendedForYouQuery';
 export * from './redirect';
 export * from './redirectRuleIndexMetadata';
 export * from './redirectRuleIndexMetadataData';
+export * from './relatedModel';
+export * from './relatedProducts';
+export * from './relatedQuery';
 export * from './removeStopWords';
 export * from './removeWordsIfNoResults';
 export * from './renderingContent';
@@ -65,7 +86,6 @@ export * from './searchMethodParams';
 export * from './searchParams';
 export * from './searchParamsObject';
 export * from './searchParamsQuery';
-export * from './searchParamsString';
 export * from './searchQuery';
 export * from './searchResponse';
 export * from './searchResponses';
@@ -79,6 +99,13 @@ export * from './snippetResultOption';
 export * from './sortRemainingBy';
 export * from './supportedLanguage';
 export * from './tagFilters';
+export * from './trendingFacetHit';
+export * from './trendingFacets';
+export * from './trendingFacetsModel';
+export * from './trendingFacetsQuery';
+export * from './trendingItems';
+export * from './trendingItemsModel';
+export * from './trendingItemsQuery';
 export * from './typoTolerance';
 export * from './typoToleranceEnum';
 export * from './value';

package/lite/model/lookingSimilar.ts

@@ -0,0 +1,15 @@
+// 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 { FallbackParams } from './fallbackParams';
+import type { LookingSimilarModel } from './lookingSimilarModel';
+
+export type LookingSimilar = {
+  model: LookingSimilarModel;
+
+  /**
+   * Unique record identifier.
+   */
+  objectID: string;
+
+  fallbackParameters?: FallbackParams;
+};

package/lite/model/lookingSimilarModel.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.
+
+/**
+ * Looking similar model.  This model recommends items that look similar to the item with the ID `objectID` based on image attributes in your index.
+ */
+export type LookingSimilarModel = 'looking-similar';

package/lite/model/lookingSimilarQuery.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 { BaseRecommendRequest } from './baseRecommendRequest';
+import type { LookingSimilar } from './lookingSimilar';
+
+export type LookingSimilarQuery = BaseRecommendRequest & LookingSimilar;

package/lite/model/recommendHit.ts

@@ -0,0 +1,34 @@
+// 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 { HighlightResult } from './highlightResult';
+import type { RankingInfo } from './rankingInfo';
+import type { SnippetResult } from './snippetResult';
+
+/**
+ * Recommend hit.
+ */
+export type RecommendHit = Record<string, any> & {
+  /**
+   * Unique record identifier.
+   */
+  objectID: string;
+
+  /**
+   * Surround words that match the query with HTML tags for highlighting.
+   */
+  _highlightResult?: Record<string, HighlightResult>;
+
+  /**
+   * Snippets that show the context around a matching search query.
+   */
+  _snippetResult?: Record<string, SnippetResult>;
+
+  _rankingInfo?: RankingInfo;
+
+  _distinctSeqID?: number;
+
+  /**
+   * Recommendation score.
+   */
+  _score: number;
+};

package/lite/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/lite/model/recommendationsHits.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 { RecommendationsHit } from './recommendationsHit';
+
+export type RecommendationsHits = {
+  hits: RecommendationsHit[];
+};

package/lite/model/recommendationsRequest.ts

@@ -0,0 +1,16 @@
+// 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 { BoughtTogetherQuery } from './boughtTogetherQuery';
+import type { LookingSimilarQuery } from './lookingSimilarQuery';
+import type { RecommendedForYouQuery } from './recommendedForYouQuery';
+import type { RelatedQuery } from './relatedQuery';
+import type { TrendingFacetsQuery } from './trendingFacetsQuery';
+import type { TrendingItemsQuery } from './trendingItemsQuery';
+
+export type RecommendationsRequest =
+  | BoughtTogetherQuery
+  | LookingSimilarQuery
+  | RecommendedForYouQuery
+  | RelatedQuery
+  | TrendingFacetsQuery
+  | TrendingItemsQuery;

package/lite/model/recommendationsResults.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 { BaseSearchResponse } from './baseSearchResponse';
+import type { RecommendationsHits } from './recommendationsHits';
+
+export type RecommendationsResults = BaseSearchResponse & RecommendationsHits;

package/lite/model/recommendedForYou.ts

@@ -0,0 +1,10 @@
+// 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 { FallbackParams } from './fallbackParams';
+import type { RecommendedForYouModel } from './recommendedForYouModel';
+
+export type RecommendedForYou = {
+  model: RecommendedForYouModel;
+
+  fallbackParameters?: FallbackParams;
+};

package/lite/model/{searchParamsString.ts → recommendedForYouModel.ts}

@@ -1,8 +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.
 
-export type SearchParamsString = {
-  /**
-   * Search parameters as a URL-encoded query string.
-   */
-  params?: string;
-};
+/**
+ * \"Recommened for you\" model.
+ */
+export type RecommendedForYouModel = 'recommended-for-you';

package/lite/model/recommendedForYouQuery.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 { BaseRecommendRequest } from './baseRecommendRequest';
+import type { RecommendedForYou } from './recommendedForYou';
+
+export type RecommendedForYouQuery = BaseRecommendRequest & RecommendedForYou;

package/lite/model/relatedModel.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.
+
+/**
+ * Related products or similar content model.  This model recommends items that are similar to the item with the ID `objectID`. Similarity is determined from the user interactions and attributes.
+ */
+export type RelatedModel = 'related-products';

package/lite/model/relatedProducts.ts

@@ -0,0 +1,15 @@
+// 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 { FallbackParams } from './fallbackParams';
+import type { RelatedModel } from './relatedModel';
+
+export type RelatedProducts = {
+  model: RelatedModel;
+
+  /**
+   * Unique record identifier.
+   */
+  objectID: string;
+
+  fallbackParameters?: FallbackParams;
+};

package/lite/model/relatedQuery.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 { BaseRecommendRequest } from './baseRecommendRequest';
+import type { RelatedProducts } from './relatedProducts';
+
+export type RelatedQuery = BaseRecommendRequest & RelatedProducts;

package/lite/model/searchParams.ts

@@ -1,6 +1,5 @@
 // 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 { SearchParamsObject } from './searchParamsObject';
-import type { SearchParamsString } from './searchParamsString';
 
-export type SearchParams = SearchParamsObject | SearchParamsString;
+export type SearchParams = Record<string, any> & SearchParamsObject;

package/lite/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 attribute. To be used in combination with `facetValue`. If specified, only recommendations matching the facet filter will be returned.
+   */
+  facetName: string;
+
+  /**
+   * Facet value. To be used in combination with `facetName`. If specified, only recommendations matching the facet filter will be returned.
+   */
+  facetValue: string;
+};

package/lite/model/trendingFacets.ts

@@ -0,0 +1,15 @@
+// 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 { FallbackParams } from './fallbackParams';
+import type { TrendingFacetsModel } from './trendingFacetsModel';
+
+export type TrendingFacets = {
+  /**
+   * Facet attribute for which to retrieve trending facet values.
+   */
+  facetName: any | null;
+
+  model: TrendingFacetsModel;
+
+  fallbackParameters?: FallbackParams;
+};

package/lite/model/trendingFacetsModel.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.
+
+/**
+ * Trending facet values model.  This model recommends trending facet values for the specified facet attribute.
+ */
+export type TrendingFacetsModel = 'trending-facets';

package/lite/model/trendingFacetsQuery.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 { BaseRecommendRequest } from './baseRecommendRequest';
+import type { TrendingFacets } from './trendingFacets';
+
+export type TrendingFacetsQuery = BaseRecommendRequest & TrendingFacets;