@algolia/recommend 5.0.0-alpha.110 → 5.0.0-alpha.111

package/dist/builds/browser.d.ts

@@ -16,7 +16,7 @@ export declare function recommendClient(appId: string, apiKey: string, options?:
     customPost({ path, parameters, body }: import("../model").CustomPostProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, any>>;
     customPut({ path, parameters, body }: import("../model").CustomPutProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, any>>;
     deleteRecommendRule({ indexName, model, objectID }: import("../model").DeleteRecommendRuleProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").DeletedAtResponse>;
-    getRecommendRule({ indexName, model, objectID }: import("../model").GetRecommendRuleProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").RuleResponse>;
+    getRecommendRule({ indexName, model, objectID }: import("../model").GetRecommendRuleProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").RecommendRule>;
     getRecommendStatus({ indexName, model, taskID }: import("../model").GetRecommendStatusProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").GetRecommendTaskResponse>;
     getRecommendations(getRecommendationsParams: import("../model").GetRecommendationsParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").GetRecommendationsResponse>;
     searchRecommendRules({ indexName, model, searchRecommendRulesParams, }: import("../model").SearchRecommendRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchRecommendRulesResponse>;

package/dist/builds/node.d.ts

@@ -16,7 +16,7 @@ export declare function recommendClient(appId: string, apiKey: string, options?:
     customPost({ path, parameters, body }: import("../model").CustomPostProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, any>>;
     customPut({ path, parameters, body }: import("../model").CustomPutProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, any>>;
     deleteRecommendRule({ indexName, model, objectID }: import("../model").DeleteRecommendRuleProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").DeletedAtResponse>;
-    getRecommendRule({ indexName, model, objectID }: import("../model").GetRecommendRuleProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").RuleResponse>;
+    getRecommendRule({ indexName, model, objectID }: import("../model").GetRecommendRuleProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").RecommendRule>;
     getRecommendStatus({ indexName, model, taskID }: import("../model").GetRecommendStatusProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").GetRecommendTaskResponse>;
     getRecommendations(getRecommendationsParams: import("../model").GetRecommendationsParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").GetRecommendationsResponse>;
     searchRecommendRules({ indexName, model, searchRecommendRulesParams, }: import("../model").SearchRecommendRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchRecommendRulesResponse>;

package/dist/model/autoFacetFilter.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Facet attribute. Only recommendations with the same value (or only recommendations with a different value) as the original viewed item are included.
+ */
+export type AutoFacetFilter = {
+    /**
+     * Facet attribute.
+     */
+    facet?: string;
+    /**
+     * Whether the filter is negative. If true, recommendations must not have the same value for the `facet` attribute. If false, recommendations must have the same value for the `facet` attribute.
+     */
+    negative?: boolean;
+};
+//# sourceMappingURL=autoFacetFilter.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"autoFacetFilter.d.ts","sourceRoot":"","sources":["../../model/autoFacetFilter.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB,CAAC"}

package/dist/model/baseRecommendRequest.d.ts

@@ -1,15 +1,17 @@
+import type { SearchParams } from './searchParams';
 export type BaseRecommendRequest = {
     /**
      * Index name.
      */
     indexName: string;
     /**
-     * Recommendations with a confidence score lower than `threshold` won\'t appear in results. > **Note**: Each recommendation has a confidence score of 0 to 100. The closer the score is to 100, the more relevant the recommendations are.
+     * Minimum score a recommendation must have to be included in the response.
      */
-    threshold?: number;
+    threshold: number;
     /**
-     * Maximum number of recommendations to retrieve. If 0, all recommendations will be returned.
+     * 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;
 };
 //# sourceMappingURL=baseRecommendRequest.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"baseRecommendRequest.d.ts","sourceRoot":"","sources":["../../model/baseRecommendRequest.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,oBAAoB,GAAG;IACjC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B,CAAC"}
+{"version":3,"file":"baseRecommendRequest.d.ts","sourceRoot":"","sources":["../../model/baseRecommendRequest.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEnD,MAAM,MAAM,oBAAoB,GAAG;IACjC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B,eAAe,CAAC,EAAE,YAAY,CAAC;CAChC,CAAC"}

package/dist/model/baseSearchParamsWithoutQuery.d.ts

@@ -10,7 +10,7 @@ export type BaseSearchParamsWithoutQuery = {
      */
     similarQuery?: string;
     /**
-     * Filter the search so that only records with matching values are included in the results.  These filters are supported:  - **Numeric filters.** `<facet> <op> <number>`, where `<op>` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`. - **Ranges.** `<facet>:<lower> TO <upper>` where `<lower>` and `<upper>` are the lower and upper limits of the range (inclusive). - **Facet filters.** `<facet>:<value>` where `<facet>` is a facet attribute (case-sensitive) and `<value>` a facet value. - **Tag filters.** `_tags:<value>` or just `<value>` (case-sensitive). - **Boolean filters.** `<facet>: true | false`.  You can combine filters with `AND`, `OR`, and `NOT` operators with the following restrictions:  - You can only combine filters of the same type with `OR`.   **Not supported:** `facet:value OR num > 3`. - You can\'t use `NOT` with combinations of filters.   **Not supported:** `NOT(facet:value OR facet:value)` - You can\'t combine conjunctions (`AND`) with `OR`.   **Not supported:** `facet:value OR (facet:value AND facet:value)`  Use quotes around your filters, if the facet attribute name or facet value has spaces, keywords (`OR`, `AND`, `NOT`), or quotes. If a facet attribute is an array, the filter matches if it matches at least one element of the array.  For more information, see [Filters](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/).
+     * Filter expression to only include items that match the filter criteria in the response.  You can use these filter expressions:  - **Numeric filters.** `<facet> <op> <number>`, where `<op>` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`. - **Ranges.** `<facet>:<lower> TO <upper>` where `<lower>` and `<upper>` are the lower and upper limits of the range (inclusive). - **Facet filters.** `<facet>:<value>` where `<facet>` is a facet attribute (case-sensitive) and `<value>` a facet value. - **Tag filters.** `_tags:<value>` or just `<value>` (case-sensitive). - **Boolean filters.** `<facet>: true | false`.  You can combine filters with `AND`, `OR`, and `NOT` operators with the following restrictions:  - You can only combine filters of the same type with `OR`.   **Not supported:** `facet:value OR num > 3`. - You can\'t use `NOT` with combinations of filters.   **Not supported:** `NOT(facet:value OR facet:value)` - You can\'t combine conjunctions (`AND`) with `OR`.   **Not supported:** `facet:value OR (facet:value AND facet:value)`  Use quotes around your filters, if the facet attribute name or facet value has spaces, keywords (`OR`, `AND`, `NOT`), or quotes. If a facet attribute is an array, the filter matches if it matches at least one element of the array.  For more information, see [Filters](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/).
      */
     filters?: string;
     facetFilters?: FacetFilters;

package/dist/model/boughtTogetherQuery.d.ts

@@ -0,0 +1,4 @@
+import type { BaseRecommendRequest } from './baseRecommendRequest';
+import type { FrequentlyBoughtTogether } from './frequentlyBoughtTogether';
+export type BoughtTogetherQuery = BaseRecommendRequest & FrequentlyBoughtTogether;
+//# sourceMappingURL=boughtTogetherQuery.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"boughtTogetherQuery.d.ts","sourceRoot":"","sources":["../../model/boughtTogetherQuery.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AAE3E,MAAM,MAAM,mBAAmB,GAAG,oBAAoB,GACpD,wBAAwB,CAAC"}

package/dist/model/clientMethodProps.d.ts

@@ -69,7 +69,7 @@ export type DeleteRecommendRuleProps = {
      */
     indexName: string;
     /**
-     * [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
+     * [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
      */
     model: RecommendModels;
     /**
@@ -86,7 +86,7 @@ export type GetRecommendRuleProps = {
      */
     indexName: string;
     /**
-     * [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
+     * [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
      */
     model: RecommendModels;
     /**
@@ -103,11 +103,11 @@ export type GetRecommendStatusProps = {
      */
     indexName: string;
     /**
-     * [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
+     * [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
      */
     model: RecommendModels;
     /**
-     * Unique identifier of a task. Numeric value (up to 64bits).
+     * Unique task identifier.
      */
     taskID: number;
 };
@@ -120,7 +120,7 @@ export type SearchRecommendRulesProps = {
      */
     indexName: string;
     /**
-     * [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
+     * [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
      */
     model: RecommendModels;
     searchRecommendRulesParams?: SearchRecommendRulesParams;

package/dist/model/condition.d.ts

@@ -1,21 +1,14 @@
-import type { Anchoring } from './anchoring';
+/**
+ * Condition that triggers the rule. If not specified, the rule is triggered for all recommendations.
+ */
 export type Condition = {
     /**
-     * Query pattern that triggers the rule.  You can use either a literal string, or a special pattern `{facet:ATTRIBUTE}`, where `ATTRIBUTE` is a facet name. The rule is triggered if the query matches the literal string or a value of the specified facet. For example, with `pattern: {facet:genre}`, the rule is triggered when users search for a genre, such as \"comedy\".
+     * Filter expression to only include items that match the filter criteria in the response.  You can use these filter expressions:  - **Numeric filters.** `<facet> <op> <number>`, where `<op>` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`. - **Ranges.** `<facet>:<lower> TO <upper>` where `<lower>` and `<upper>` are the lower and upper limits of the range (inclusive). - **Facet filters.** `<facet>:<value>` where `<facet>` is a facet attribute (case-sensitive) and `<value>` a facet value. - **Tag filters.** `_tags:<value>` or just `<value>` (case-sensitive). - **Boolean filters.** `<facet>: true | false`.  You can combine filters with `AND`, `OR`, and `NOT` operators with the following restrictions:  - You can only combine filters of the same type with `OR`.   **Not supported:** `facet:value OR num > 3`. - You can\'t use `NOT` with combinations of filters.   **Not supported:** `NOT(facet:value OR facet:value)` - You can\'t combine conjunctions (`AND`) with `OR`.   **Not supported:** `facet:value OR (facet:value AND facet:value)`  Use quotes around your filters, if the facet attribute name or facet value has spaces, keywords (`OR`, `AND`, `NOT`), or quotes. If a facet attribute is an array, the filter matches if it matches at least one element of the array.  For more information, see [Filters](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/).
      */
-    pattern?: string;
-    anchoring?: Anchoring;
-    /**
-     * Whether the pattern should match plurals, synonyms, and typos.
-     */
-    alternatives?: boolean;
+    filters?: string;
     /**
      * An additional restriction that only triggers the rule, when the search has the same value as `ruleContexts` parameter. For example, if `context: mobile`, the rule is only triggered when the search request has a matching `ruleContexts: mobile`. A rule context must only contain alphanumeric characters.
      */
     context?: string;
-    /**
-     * Filters that trigger the rule.  You can add add filters using the syntax `facet:value` so that the rule is triggered, when the specific filter is selected. You can use `filters` on its own or combine it with the `pattern` parameter.
-     */
-    filters?: string;
 };
 //# sourceMappingURL=condition.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"condition.d.ts","sourceRoot":"","sources":["../../model/condition.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C,MAAM,MAAM,SAAS,GAAG;IACtB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,SAAS,CAAC,EAAE,SAAS,CAAC;IAEtB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC"}
+{"version":3,"file":"condition.d.ts","sourceRoot":"","sources":["../../model/condition.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG;IACtB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC"}

package/dist/model/consequence.d.ts

@@ -1,26 +1,18 @@
-import type { ConsequenceHide } from './consequenceHide';
-import type { ConsequenceParams } from './consequenceParams';
-import type { Promote } from './promote';
+import type { HideConsequenceObject } from './hideConsequenceObject';
+import type { ParamsConsequence } from './paramsConsequence';
+import type { PromoteConsequenceObject } from './promoteConsequenceObject';
 /**
- * Effect of the rule.  For more information, see [Consequences](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/#consequences).
+ * Effect of the rule.
  */
 export type Consequence = {
-    params?: ConsequenceParams;
     /**
-     * Records you want to pin to a specific position in the search results.  You can promote up to 300 records, either individually, or as groups of up to 100 records each.
+     * Exclude items from recommendations.
      */
-    promote?: Promote[];
+    hide?: HideConsequenceObject[];
     /**
-     * Whether promoted records must match an active filter for the consequence to be applied.  This ensures that user actions (filtering the search) are given a higher precendence. For example, if you promote a record with the `color: red` attribute, and the user filters the search for `color: blue`, the \"red\" record won\'t be shown.
+     * Place items at specific positions in the list of recommendations.
      */
-    filterPromotes?: boolean;
-    /**
-     * Records you want to hide from the search results.
-     */
-    hide?: ConsequenceHide[];
-    /**
-     * A JSON object with custom data that will be appended to the `userData` array in the response. This object isn\'t interpreted by the API and is limited to 1 kB of minified JSON.
-     */
-    userData?: any | null;
+    promote?: PromoteConsequenceObject[];
+    params?: ParamsConsequence;
 };
 //# sourceMappingURL=consequence.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"consequence.d.ts","sourceRoot":"","sources":["../../model/consequence.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAC7D,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEzC;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,MAAM,CAAC,EAAE,iBAAiB,CAAC;IAE3B;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,EAAE,CAAC;IAEpB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,IAAI,CAAC,EAAE,eAAe,EAAE,CAAC;IAEzB;;OAEG;IACH,QAAQ,CAAC,EAAE,GAAG,GAAG,IAAI,CAAC;CACvB,CAAC"}
+{"version":3,"file":"consequence.d.ts","sourceRoot":"","sources":["../../model/consequence.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AACrE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAC7D,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AAE3E;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB;;OAEG;IACH,IAAI,CAAC,EAAE,qBAAqB,EAAE,CAAC;IAE/B;;OAEG;IACH,OAAO,CAAC,EAAE,wBAAwB,EAAE,CAAC;IAErC,MAAM,CAAC,EAAE,iBAAiB,CAAC;CAC5B,CAAC"}

package/dist/model/deletedAtResponse.d.ts

@@ -7,7 +7,7 @@ export type DeletedAtResponse = {
      */
     taskID: number;
     /**
-     * Timestamp of deletion in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
+     * Date and time when the object was deleted, in RFC 3339 format.
      */
     deletedAt: string;
 };

package/dist/model/exactOnSingleWordQuery.d.ts

@@ -1,5 +1,5 @@
 /**
- * Determines how the [Exact ranking criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes) is computed when the search query has only one word.  <dl> <dt><code>attribute</code></dt> <dd> The Exact ranking criterion is 1 if the query word and attribute value are the same. For example, a search for \"road\" will match the value \"road\", but not \"road trip\". </dd> <dt><code>none</code></dt> <dd> The Exact ranking criterion is ignored on single-word searches. </dd> <dt><code>word</code></dt> <dd> The Exact ranking criterion is 1 if the query word is found in the attribute value. The query word must have at least 3 characters and must not be a stop word. </dd> </dl>  If `exactOnSingleWordQuery` is `word`, only exact matches will be highlighted, partial and prefix matches won\'t.
+ * Determines how the [Exact ranking criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes) is computed when the search query has only one word.  - `attribute`.   The Exact ranking criterion is 1 if the query word and attribute value are the same.   For example, a search for \"road\" will match the value \"road\", but not \"road trip\".  - `none`.   The Exact ranking criterion is ignored on single-word searches.  - `word`.   The Exact ranking criterion is 1 if the query word is found in the attribute value.   The query word must have at least 3 characters and must not be a stop word.   Only exact matches will be highlighted,   partial and prefix matches won\'t.
  */
 export type ExactOnSingleWordQuery = 'attribute' | 'none' | 'word';
 //# sourceMappingURL=exactOnSingleWordQuery.d.ts.map

package/dist/model/fallbackParams.d.ts

@@ -0,0 +1,3 @@
+import type { SearchParamsObject } from './searchParamsObject';
+export type FallbackParams = Record<string, any> & SearchParamsObject;
+//# sourceMappingURL=fallbackParams.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"fallbackParams.d.ts","sourceRoot":"","sources":["../../model/fallbackParams.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,kBAAkB,CAAC"}

package/dist/model/fbtModel.d.ts

@@ -0,0 +1,5 @@
+/**
+ * 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';
+//# sourceMappingURL=fbtModel.d.ts.map

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

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

package/dist/model/frequentlyBoughtTogether.d.ts

@@ -0,0 +1,9 @@
+import type { FbtModel } from './fbtModel';
+export type FrequentlyBoughtTogether = {
+    model: FbtModel;
+    /**
+     * Unique record identifier.
+     */
+    objectID: string;
+};
+//# sourceMappingURL=frequentlyBoughtTogether.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"frequentlyBoughtTogether.d.ts","sourceRoot":"","sources":["../../model/frequentlyBoughtTogether.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAE3C,MAAM,MAAM,wBAAwB,GAAG;IACrC,KAAK,EAAE,QAAQ,CAAC;IAEhB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC"}

package/dist/model/getRecommendationsParams.d.ts

@@ -1,10 +1,10 @@
 import type { RecommendationsRequest } from './recommendationsRequest';
 /**
- * Recommend parameters.
+ * Recommend request body.
  */
 export type GetRecommendationsParams = {
     /**
-     * Request parameters depend on the model (recommendations or trending).
+     * Recommendation request with parameters depending on the requested model.
      */
     requests: RecommendationsRequest[];
 };

package/dist/model/hideConsequenceObject.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Object ID of the recommendation you want to exclude.
+ */
+export type HideConsequenceObject = {
+    /**
+     * Unique record identifier.
+     */
+    objectID?: string;
+};
+//# sourceMappingURL=hideConsequenceObject.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"hideConsequenceObject.d.ts","sourceRoot":"","sources":["../../model/hideConsequenceObject.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC"}

package/dist/model/index.d.ts

@@ -1,31 +1,19 @@
 export * from './advancedSyntaxFeatures';
 export * from './alternativesAsExact';
-export * from './anchoring';
 export * from './aroundPrecision';
 export * from './aroundPrecisionFromValueInner';
 export * from './aroundRadius';
 export * from './aroundRadiusAll';
-export * from './automaticFacetFilter';
-export * from './automaticFacetFilters';
+export * from './autoFacetFilter';
 export * from './baseRecommendRequest';
-export * from './baseRecommendationsQuery';
-export * from './baseRecommendedForYouQuery';
-export * from './baseRecommendedForYouQueryParameters';
 export * from './baseSearchParams';
 export * from './baseSearchParamsWithoutQuery';
 export * from './baseSearchResponse';
-export * from './baseTrendingFacetsQuery';
-export * from './baseTrendingItemsQuery';
+export * from './boughtTogetherQuery';
 export * from './condition';
 export * from './consequence';
-export * from './consequenceHide';
-export * from './consequenceParams';
-export * from './consequenceQuery';
-export * from './consequenceQueryObject';
 export * from './deletedAtResponse';
 export * from './distinct';
-export * from './edit';
-export * from './editType';
 export * from './errorBase';
 export * from './exactOnSingleWordQuery';
 export * from './exhaustive';
@@ -33,46 +21,53 @@ export * from './facetFilters';
 export * from './facetOrdering';
 export * from './facets';
 export * from './facetsStats';
+export * from './fallbackParams';
+export * from './fbtModel';
+export * from './frequentlyBoughtTogether';
 export * from './getRecommendTaskResponse';
 export * from './getRecommendationsParams';
 export * from './getRecommendationsResponse';
+export * from './hideConsequenceObject';
 export * from './highlightResult';
 export * from './highlightResultOption';
 export * from './ignorePlurals';
 export * from './indexSettingsAsSearchParams';
+export * from './lookingSimilar';
+export * from './lookingSimilarModel';
+export * from './lookingSimilarQuery';
 export * from './matchLevel';
 export * from './matchedGeoLocation';
 export * from './mixedSearchFilters';
 export * from './mode';
 export * from './numericFilters';
 export * from './optionalFilters';
-export * from './params';
+export * from './paramsConsequence';
 export * from './personalization';
-export * from './promote';
-export * from './promoteObjectID';
-export * from './promoteObjectIDs';
+export * from './promoteConsequenceObject';
 export * from './queryType';
 export * from './rankingInfo';
 export * from './reRankingApplyFilter';
 export * from './recommendHit';
 export * from './recommendModels';
-export * from './recommendationModels';
+export * from './recommendRule';
+export * from './recommendRuleMetadata';
 export * from './recommendationsHit';
 export * from './recommendationsHits';
-export * from './recommendationsQuery';
 export * from './recommendationsRequest';
 export * from './recommendationsResults';
+export * from './recommendedForYou';
 export * from './recommendedForYouModel';
 export * from './recommendedForYouQuery';
-export * from './recommendedForYouQueryParameters';
 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';
-export * from './ruleResponse';
-export * from './ruleResponseMetadata';
+export * from './searchParams';
 export * from './searchParamsObject';
 export * from './searchParamsQuery';
 export * from './searchRecommendRulesParams';
@@ -85,8 +80,10 @@ export * from './supportedLanguage';
 export * from './tagFilters';
 export * from './taskStatus';
 export * from './trendingFacetHit';
+export * from './trendingFacets';
 export * from './trendingFacetsModel';
 export * from './trendingFacetsQuery';
+export * from './trendingItems';
 export * from './trendingItemsModel';
 export * from './trendingItemsQuery';
 export * from './typoTolerance';

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../model/index.ts"],"names":[],"mappings":"AAEA,cAAc,0BAA0B,CAAC;AACzC,cAAc,uBAAuB,CAAC;AACtC,cAAc,aAAa,CAAC;AAC5B,cAAc,mBAAmB,CAAC;AAClC,cAAc,iCAAiC,CAAC;AAChD,cAAc,gBAAgB,CAAC;AAC/B,cAAc,mBAAmB,CAAC;AAClC,cAAc,wBAAwB,CAAC;AACvC,cAAc,yBAAyB,CAAC;AACxC,cAAc,wBAAwB,CAAC;AACvC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,wCAAwC,CAAC;AACvD,cAAc,oBAAoB,CAAC;AACnC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,sBAAsB,CAAC;AACrC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,0BAA0B,CAAC;AACzC,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC;AAC9B,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC;AACpC,cAAc,oBAAoB,CAAC;AACnC,cAAc,0BAA0B,CAAC;AACzC,cAAc,qBAAqB,CAAC;AACpC,cAAc,YAAY,CAAC;AAC3B,cAAc,QAAQ,CAAC;AACvB,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,0BAA0B,CAAC;AACzC,cAAc,cAAc,CAAC;AAC7B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,UAAU,CAAC;AACzB,cAAc,eAAe,CAAC;AAC9B,cAAc,4BAA4B,CAAC;AAC3C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,mBAAmB,CAAC;AAClC,cAAc,yBAAyB,CAAC;AACxC,cAAc,iBAAiB,CAAC;AAChC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,cAAc,CAAC;AAC7B,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,QAAQ,CAAC;AACvB,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,UAAU,CAAC;AACzB,cAAc,mBAAmB,CAAC;AAClC,cAAc,WAAW,CAAC;AAC1B,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC;AAC9B,cAAc,wBAAwB,CAAC;AACvC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,mBAAmB,CAAC;AAClC,cAAc,wBAAwB,CAAC;AACvC,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,wBAAwB,CAAC;AACvC,cAAc,0BAA0B,CAAC;AACzC,cAAc,0BAA0B,CAAC;AACzC,cAAc,0BAA0B,CAAC;AACzC,cAAc,0BAA0B,CAAC;AACzC,cAAc,oCAAoC,CAAC;AACnD,cAAc,YAAY,CAAC;AAC3B,cAAc,6BAA6B,CAAC;AAC5C,cAAc,iCAAiC,CAAC;AAChD,cAAc,mBAAmB,CAAC;AAClC,cAAc,0BAA0B,CAAC;AACzC,cAAc,oBAAoB,CAAC;AACnC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,wBAAwB,CAAC;AACvC,cAAc,sBAAsB,CAAC;AACrC,cAAc,qBAAqB,CAAC;AACpC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,kBAAkB,CAAC;AACjC,cAAc,iBAAiB,CAAC;AAChC,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC;AACpC,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC;AAC7B,cAAc,oBAAoB,CAAC;AACnC,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC;AACtC,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,iBAAiB,CAAC;AAChC,cAAc,qBAAqB,CAAC;AACpC,cAAc,SAAS,CAAC;AACxB,cAAc,qBAAqB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../model/index.ts"],"names":[],"mappings":"AAEA,cAAc,0BAA0B,CAAC;AACzC,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,iCAAiC,CAAC;AAChD,cAAc,gBAAgB,CAAC;AAC/B,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,wBAAwB,CAAC;AACvC,cAAc,oBAAoB,CAAC;AACnC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC;AAC9B,cAAc,qBAAqB,CAAC;AACpC,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,0BAA0B,CAAC;AACzC,cAAc,cAAc,CAAC;AAC7B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,UAAU,CAAC;AACzB,cAAc,eAAe,CAAC;AAC9B,cAAc,kBAAkB,CAAC;AACjC,cAAc,YAAY,CAAC;AAC3B,cAAc,4BAA4B,CAAC;AAC3C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,yBAAyB,CAAC;AACxC,cAAc,mBAAmB,CAAC;AAClC,cAAc,yBAAyB,CAAC;AACxC,cAAc,iBAAiB,CAAC;AAChC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,kBAAkB,CAAC;AACjC,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC;AACtC,cAAc,cAAc,CAAC;AAC7B,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,QAAQ,CAAC;AACvB,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAClC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC;AAC9B,cAAc,wBAAwB,CAAC;AACvC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,mBAAmB,CAAC;AAClC,cAAc,iBAAiB,CAAC;AAChC,cAAc,yBAAyB,CAAC;AACxC,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,0BAA0B,CAAC;AACzC,cAAc,0BAA0B,CAAC;AACzC,cAAc,qBAAqB,CAAC;AACpC,cAAc,0BAA0B,CAAC;AACzC,cAAc,0BAA0B,CAAC;AACzC,cAAc,YAAY,CAAC;AAC3B,cAAc,6BAA6B,CAAC;AAC5C,cAAc,iCAAiC,CAAC;AAChD,cAAc,gBAAgB,CAAC;AAC/B,cAAc,mBAAmB,CAAC;AAClC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,mBAAmB,CAAC;AAClC,cAAc,0BAA0B,CAAC;AACzC,cAAc,oBAAoB,CAAC;AACnC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,sBAAsB,CAAC;AACrC,cAAc,qBAAqB,CAAC;AACpC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,kBAAkB,CAAC;AACjC,cAAc,iBAAiB,CAAC;AAChC,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC;AACpC,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC;AAC7B,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC;AACtC,cAAc,iBAAiB,CAAC;AAChC,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,iBAAiB,CAAC;AAChC,cAAc,qBAAqB,CAAC;AACpC,cAAc,SAAS,CAAC;AACxB,cAAc,qBAAqB,CAAC"}

package/dist/model/indexSettingsAsSearchParams.d.ts

@@ -18,11 +18,11 @@ export type IndexSettingsAsSearchParams = {
      */
     attributesToRetrieve?: string[];
     /**
-     * Determines the order in which Algolia returns your results.  By default, each entry corresponds to a [ranking criteria](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/). The tie-breaking algorithm sequentially applies each criterion in the order they\'re specified. If you configure a replica index for [sorting by an attribute](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/sort-by-attribute/), you put the sorting attribute at the top of the list.  **Modifiers**  <dl> <dt><code>asc(\"ATTRIBUTE\")</code></dt> <dd>Sort the index by the values of an attribute, in ascending order.</dd> <dt><code>desc(\"ATTRIBUTE\")</code></dt> <dd>Sort the index by the values of an attribute, in descending order.</dd> </dl>  Before you modify the default setting, you should test your changes in the dashboard, and by [A/B testing](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing/).
+     * Determines the order in which Algolia returns your results.  By default, each entry corresponds to a [ranking criteria](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/). The tie-breaking algorithm sequentially applies each criterion in the order they\'re specified. If you configure a replica index for [sorting by an attribute](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/sort-by-attribute/), you put the sorting attribute at the top of the list.  **Modifiers**  - `asc(\"ATTRIBUTE\")`.   Sort the index by the values of an attribute, in ascending order. - `desc(\"ATTRIBUTE\")`.   Sort the index by the values of an attribute, in descending order.  Before you modify the default setting, you should test your changes in the dashboard, and by [A/B testing](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing/).
      */
     ranking?: string[];
     /**
-     * Attributes to use as [custom ranking](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/).  The custom ranking attributes decide which items are shown first if the other ranking criteria are equal.  Records with missing values for your selected custom ranking attributes are always sorted last. Boolean attributes are sorted based on their alphabetical order.  **Modifiers**  <dl> <dt><code>asc(\"ATTRIBUTE\")</code></dt> <dd>Sort the index by the values of an attribute, in ascending order.</dd> <dt><code>desc(\"ATTRIBUTE\")</code></dt> <dd>Sort the index by the values of an attribute, in descending order.</dd> </dl>  If you use two or more custom ranking attributes, [reduce the precision](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/how-to/controlling-custom-ranking-metrics-precision/) of your first attributes, or the other attributes will never be applied.
+     * Attributes to use as [custom ranking](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/).  The custom ranking attributes decide which items are shown first if the other ranking criteria are equal.  Records with missing values for your selected custom ranking attributes are always sorted last. Boolean attributes are sorted based on their alphabetical order.  **Modifiers**  - `asc(\"ATTRIBUTE\")`.   Sort the index by the values of an attribute, in ascending order.  - `desc(\"ATTRIBUTE\")`.   Sort the index by the values of an attribute, in descending order.  If you use two or more custom ranking attributes, [reduce the precision](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/how-to/controlling-custom-ranking-metrics-precision/) of your first attributes, or the other attributes will never be applied.
      */
     customRanking?: string[];
     /**
@@ -114,11 +114,11 @@ export type IndexSettingsAsSearchParams = {
     disableExactOnAttributes?: string[];
     exactOnSingleWordQuery?: ExactOnSingleWordQuery;
     /**
-     * Alternatives of query words that should be considered as exact matches by the Exact ranking criterion.  <dl> <dt><code>ignorePlurals</code></dt> <dd>  Plurals and similar declensions added by the `ignorePlurals` setting are considered exact matches.  </dd> <dt><code>singleWordSynonym</code></dt> <dd> Single-word synonyms, such as \"NY/NYC\" are considered exact matches. </dd> <dt><code>multiWordsSynonym</code></dt> <dd> Multi-word synonyms, such as \"NY/New York\" are considered exact matches. </dd> </dl>.
+     * Alternatives of query words that should be considered as exact matches by the Exact ranking criterion.  - `ignorePlurals`.   Plurals and similar declensions added by the `ignorePlurals` setting are considered exact matches.  - `singleWordSynonym`.   Single-word synonyms, such as \"NY/NYC\" are considered exact matches.  - `multiWordsSynonym`.   Multi-word synonyms, such as \"NY/New York\" are considered exact matches.
      */
     alternativesAsExact?: AlternativesAsExact[];
     /**
-     * Advanced search syntax features you want to support.  <dl> <dt><code>exactPhrase</code></dt> <dd>  Phrases in quotes must match exactly. For example, `sparkly blue \"iPhone case\"` only returns records with the exact string \"iPhone case\".  </dd> <dt><code>excludeWords</code></dt> <dd>  Query words prefixed with a `-` must not occur in a record. For example, `search -engine` matches records that contain \"search\" but not \"engine\".  </dd> </dl>  This setting only has an effect if `advancedSyntax` is true.
+     * Advanced search syntax features you want to support.  - `exactPhrase`.   Phrases in quotes must match exactly.   For example, `sparkly blue \"iPhone case\"` only returns records with the exact string \"iPhone case\".  - `excludeWords`.   Query words prefixed with a `-` must not occur in a record.   For example, `search -engine` matches records that contain \"search\" but not \"engine\".  This setting only has an effect if `advancedSyntax` is true.
      */
     advancedSyntaxFeatures?: AdvancedSyntaxFeatures[];
     distinct?: Distinct;
@@ -143,7 +143,7 @@ export type IndexSettingsAsSearchParams = {
      */
     maxValuesPerFacet?: number;
     /**
-     * Order in which to retrieve facet values.  <dl> <dt><code>count</code></dt> <dd> Facet values are retrieved by decreasing count. The count is the number of matching records containing this facet value. </dd> <dt><code>alpha</code></dt> <dd>Retrieve facet values alphabetically.</dd> </dl>  This setting doesn\'t influence how facet values are displayed in your UI (see `renderingContent`). For more information, see [facet value display](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/facet-display/js/).
+     * Order in which to retrieve facet values.  - `count`.   Facet values are retrieved by decreasing count.   The count is the number of matching records containing this facet value.  - `alpha`.   Retrieve facet values alphabetically.  This setting doesn\'t influence how facet values are displayed in your UI (see `renderingContent`). For more information, see [facet value display](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/facet-display/js/).
      */
     sortFacetValuesBy?: string;
     /**

package/dist/model/lookingSimilar.d.ts

@@ -0,0 +1,11 @@
+import type { FallbackParams } from './fallbackParams';
+import type { LookingSimilarModel } from './lookingSimilarModel';
+export type LookingSimilar = {
+    model: LookingSimilarModel;
+    /**
+     * Unique record identifier.
+     */
+    objectID: string;
+    fallbackParameters?: FallbackParams;
+};
+//# sourceMappingURL=lookingSimilar.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"lookingSimilar.d.ts","sourceRoot":"","sources":["../../model/lookingSimilar.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAEjE,MAAM,MAAM,cAAc,GAAG;IAC3B,KAAK,EAAE,mBAAmB,CAAC;IAE3B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB,kBAAkB,CAAC,EAAE,cAAc,CAAC;CACrC,CAAC"}

package/dist/model/lookingSimilarModel.d.ts

@@ -0,0 +1,5 @@
+/**
+ * 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';
+//# sourceMappingURL=lookingSimilarModel.d.ts.map

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

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

package/dist/model/lookingSimilarQuery.d.ts

@@ -0,0 +1,4 @@
+import type { BaseRecommendRequest } from './baseRecommendRequest';
+import type { LookingSimilar } from './lookingSimilar';
+export type LookingSimilarQuery = BaseRecommendRequest & LookingSimilar;
+//# sourceMappingURL=lookingSimilarQuery.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"lookingSimilarQuery.d.ts","sourceRoot":"","sources":["../../model/lookingSimilarQuery.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAEvD,MAAM,MAAM,mBAAmB,GAAG,oBAAoB,GAAG,cAAc,CAAC"}

package/dist/model/paramsConsequence.d.ts

@@ -0,0 +1,19 @@
+import type { AutoFacetFilter } from './autoFacetFilter';
+/**
+ * Filter or boost recommendations matching a facet filter.
+ */
+export type ParamsConsequence = {
+    /**
+     * Filter recommendations that match or don\'t match the same `facet:facet_value` combination as the viewed item.
+     */
+    automaticFacetFilters?: AutoFacetFilter[];
+    /**
+     * Filter expression to only include items that match the filter criteria in the response.  You can use these filter expressions:  - **Numeric filters.** `<facet> <op> <number>`, where `<op>` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`. - **Ranges.** `<facet>:<lower> TO <upper>` where `<lower>` and `<upper>` are the lower and upper limits of the range (inclusive). - **Facet filters.** `<facet>:<value>` where `<facet>` is a facet attribute (case-sensitive) and `<value>` a facet value. - **Tag filters.** `_tags:<value>` or just `<value>` (case-sensitive). - **Boolean filters.** `<facet>: true | false`.  You can combine filters with `AND`, `OR`, and `NOT` operators with the following restrictions:  - You can only combine filters of the same type with `OR`.   **Not supported:** `facet:value OR num > 3`. - You can\'t use `NOT` with combinations of filters.   **Not supported:** `NOT(facet:value OR facet:value)` - You can\'t combine conjunctions (`AND`) with `OR`.   **Not supported:** `facet:value OR (facet:value AND facet:value)`  Use quotes around your filters, if the facet attribute name or facet value has spaces, keywords (`OR`, `AND`, `NOT`), or quotes. If a facet attribute is an array, the filter matches if it matches at least one element of the array.  For more information, see [Filters](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/).
+     */
+    filters?: string;
+    /**
+     * Filters to promote or demote records in the search results.  Optional filters work like facet filters, but they don\'t exclude records from the search results. Records that match the optional filter rank before records that don\'t match. Matches with higher weights (`<score=N>`) rank before matches with lower weights. If you\'re using a negative filter `facet:-value`, matching records rank after records that don\'t match.
+     */
+    optionalFilters?: string[];
+};
+//# sourceMappingURL=paramsConsequence.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"paramsConsequence.d.ts","sourceRoot":"","sources":["../../model/paramsConsequence.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,qBAAqB,CAAC,EAAE,eAAe,EAAE,CAAC;IAE1C;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;CAC5B,CAAC"}

package/dist/model/promoteConsequenceObject.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Object ID and position of the recommendation you want to pin.
+ */
+export type PromoteConsequenceObject = {
+    /**
+     * Unique record identifier.
+     */
+    objectID?: string;
+    /**
+     * Index in the list of recommendations where to place this item.
+     */
+    position?: number;
+};
+//# sourceMappingURL=promoteConsequenceObject.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"promoteConsequenceObject.d.ts","sourceRoot":"","sources":["../../model/promoteConsequenceObject.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC"}

package/dist/model/recommendRule.d.ts

@@ -0,0 +1,24 @@
+import type { Condition } from './condition';
+import type { Consequence } from './consequence';
+import type { RecommendRuleMetadata } from './recommendRuleMetadata';
+/**
+ * Recommend rule.
+ */
+export type RecommendRule = {
+    _metadata?: RecommendRuleMetadata;
+    /**
+     * Unique identifier of a rule object.
+     */
+    objectID?: string;
+    condition?: Condition;
+    consequence?: Consequence;
+    /**
+     * Description of the rule\'s purpose. This can be helpful for display in the Algolia dashboard.
+     */
+    description?: string;
+    /**
+     * Indicates whether to enable the rule. If it isn\'t enabled, it isn\'t applied at query time.
+     */
+    enabled?: boolean;
+};
+//# sourceMappingURL=recommendRule.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"recommendRule.d.ts","sourceRoot":"","sources":["../../model/recommendRule.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAErE;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,SAAS,CAAC,EAAE,qBAAqB,CAAC;IAElC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,SAAS,CAAC,EAAE,SAAS,CAAC;IAEtB,WAAW,CAAC,EAAE,WAAW,CAAC;IAE1B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC"}

package/dist/model/recommendRuleMetadata.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Rule metadata.
+ */
+export type RecommendRuleMetadata = {
+    /**
+     * Date and time when the object was updated, in RFC 3339 format.
+     */
+    lastUpdate?: string;
+};
+//# sourceMappingURL=recommendRuleMetadata.d.ts.map