@algolia/recommend 5.6.1 → 5.7.0

package/dist/fetch.d.ts

@@ -3,6 +3,137 @@ import { CreateClientOptions, RequestOptions, ClientOptions } from '@algolia/cli
 
 type RecommendModels = 'bought-together' | 'related-products' | 'trending-facets' | 'trending-items';
 
+/**
+ * Condition that triggers the rule. If not specified, the rule is triggered for all recommendations.
+ */
+type Condition = {
+    /**
+     * 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;
+    /**
+     * 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;
+};
+
+/**
+ * Object ID of the recommendation you want to exclude.
+ */
+type HideConsequenceObject = {
+    /**
+     * Unique record identifier.
+     */
+    objectID?: string;
+};
+
+/**
+ * Facet attribute. Only recommendations with the same value (or only recommendations with a different value) as the original viewed item are included.
+ */
+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;
+};
+
+/**
+ * Filter or boost recommendations matching a facet filter.
+ */
+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[];
+};
+
+/**
+ * Object ID and position of the recommendation you want to pin.
+ */
+type PromoteConsequenceObject = {
+    /**
+     * Unique record identifier.
+     */
+    objectID?: string;
+    /**
+     * Index in the list of recommendations where to place this item.
+     */
+    position?: number;
+};
+
+/**
+ * Effect of the rule.
+ */
+type Consequence = {
+    /**
+     * Exclude items from recommendations.
+     */
+    hide?: HideConsequenceObject[];
+    /**
+     * Place items at specific positions in the list of recommendations.
+     */
+    promote?: PromoteConsequenceObject[];
+    params?: ParamsConsequence;
+};
+
+/**
+ * Rule metadata.
+ */
+type RuleMetadata = {
+    /**
+     * Date and time when the object was updated, in RFC 3339 format.
+     */
+    lastUpdate?: string;
+};
+
+type TimeRange = {
+    /**
+     * When the rule should start to be active, in Unix epoch time.
+     */
+    from: number;
+    /**
+     * When the rule should stop to be active, in Unix epoch time.
+     */
+    until: number;
+};
+
+/**
+ * Recommend rule.
+ */
+type RecommendRule = {
+    _metadata?: RuleMetadata;
+    /**
+     * 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;
+    /**
+     * Time periods when the rule is active.
+     */
+    validity?: TimeRange[];
+};
+
 /**
  * Range object with lower and upper values in meters to define custom ranges.
  */
@@ -631,6 +762,20 @@ type SearchRecommendRulesParams = {
     maxValuesPerFacet?: number;
 };
 
+/**
+ * Properties for the `batchRecommendRules` method.
+ */
+type BatchRecommendRulesProps = {
+    /**
+     * Name of the index on which to perform the operation.
+     */
+    indexName: string;
+    /**
+     * [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
+     */
+    model: RecommendModels;
+    recommendRule?: RecommendRule[];
+};
 /**
  * Properties for the `customDelete` method.
  */
@@ -1168,119 +1313,17 @@ type GetRecommendationsResponse = {
 };
 
 /**
- * Condition that triggers the rule. If not specified, the rule is triggered for all recommendations.
- */
-type Condition = {
-    /**
-     * 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;
-    /**
-     * 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;
-};
-
-/**
- * Object ID of the recommendation you want to exclude.
+ * Response, taskID, and update timestamp.
  */
-type HideConsequenceObject = {
+type RecommendUpdatedAtResponse = {
     /**
-     * Unique record identifier.
-     */
-    objectID?: string;
-};
-
-/**
- * Facet attribute. Only recommendations with the same value (or only recommendations with a different value) as the original viewed item are included.
- */
-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;
-};
-
-/**
- * Filter or boost recommendations matching a facet filter.
- */
-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[];
-};
-
-/**
- * Object ID and position of the recommendation you want to pin.
- */
-type PromoteConsequenceObject = {
-    /**
-     * Unique record identifier.
-     */
-    objectID?: string;
-    /**
-     * Index in the list of recommendations where to place this item.
-     */
-    position?: number;
-};
-
-/**
- * Effect of the rule.
- */
-type Consequence = {
-    /**
-     * Exclude items from recommendations.
-     */
-    hide?: HideConsequenceObject[];
-    /**
-     * Place items at specific positions in the list of recommendations.
+     * Unique identifier of a task.  A successful API response means that a task was added to a queue. It might not run immediately. You can check the task\'s progress with the [`task` operation](#tag/Indices/operation/getTask) and this `taskID`.
      */
-    promote?: PromoteConsequenceObject[];
-    params?: ParamsConsequence;
-};
-
-/**
- * Rule metadata.
- */
-type RuleMetadata = {
+    taskID: number;
     /**
      * Date and time when the object was updated, in RFC 3339 format.
      */
-    lastUpdate?: string;
-};
-
-/**
- * Recommend rule.
- */
-type RecommendRule = {
-    _metadata?: RuleMetadata;
-    /**
-     * 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;
+    updatedAt: string;
 };
 
 type SearchRecommendRulesResponse = {
@@ -1302,7 +1345,7 @@ type SearchRecommendRulesResponse = {
     nbPages: number;
 };
 
-declare const apiClientVersion = "5.6.1";
+declare const apiClientVersion = "5.7.0";
 declare function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
     transporter: _algolia_client_common.Transporter;
     /**
@@ -1333,6 +1376,19 @@ declare function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOptio
     setClientApiKey({ apiKey }: {
         apiKey: string;
     }): void;
+    /**
+     * Create or update a batch of Recommend Rules  Each Recommend Rule is created or updated, depending on whether a Recommend Rule with the same `objectID` already exists. You may also specify `true` for `clearExistingRules`, in which case the batch will atomically replace all the existing Recommend Rules.  Recommend Rules are similar to Search Rules, except that the conditions and consequences apply to a [source item](/doc/guides/algolia-recommend/overview/#recommend-models) instead of a query. The main differences are the following: - Conditions `pattern` and `anchoring` are unavailable. - Condition `filters` triggers if the source item matches the specified filters. - Condition `filters` accepts numeric filters. - Consequence `params` only covers filtering parameters. - Consequence `automaticFacetFilters` doesn\'t require a facet value placeholder (it tries to match the data source item\'s attributes instead).
+     *
+     * Required API Key ACLs:
+     * - editSettings.
+     *
+     * @param batchRecommendRules - The batchRecommendRules object.
+     * @param batchRecommendRules.indexName - Name of the index on which to perform the operation.
+     * @param batchRecommendRules.model - [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
+     * @param batchRecommendRules.recommendRule - The recommendRule object.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    batchRecommendRules({ indexName, model, recommendRule }: BatchRecommendRulesProps, requestOptions?: RequestOptions): Promise<RecommendUpdatedAtResponse>;
     /**
      * This method allow you to send requests to the Algolia REST API.
      *
@@ -1446,4 +1502,4 @@ type RecommendClient = ReturnType<typeof createRecommendClient>;
 
 declare function recommendClient(appId: string, apiKey: string, options?: ClientOptions): RecommendClient;
 
-export { type AdvancedSyntaxFeatures, type AlternativesAsExact, type AroundPrecision, type AroundRadius, type AroundRadiusAll, type AutoFacetFilter, type BaseIndexSettings, type BaseRecommendIndexSettings, type BaseRecommendRequest, type BaseRecommendSearchParams, type BaseSearchResponse, type BooleanString, type BoughtTogetherQuery, type Condition, type Consequence, type CustomDeleteProps, type CustomGetProps, type CustomPostProps, type CustomPutProps, type DeleteRecommendRuleProps, type DeletedAtResponse, type Distinct, type ErrorBase, type ExactOnSingleWordQuery, type Exhaustive, type FacetFilters, type FacetOrdering, type FacetStats, type FallbackParams, type FbtModel, type FrequentlyBoughtTogether, type GetRecommendRuleProps, type GetRecommendStatusProps, type GetRecommendTaskResponse, type GetRecommendationsParams, type GetRecommendationsResponse, type HideConsequenceObject, type HighlightResult, type HighlightResultOption, type IgnorePlurals, type IndexSettingsFacets, type LegacyGetRecommendationsParams, type LookingSimilar, type LookingSimilarModel, type LookingSimilarQuery, type MatchLevel, type MatchedGeoLocation, type NumericFilters, type OptionalFilters, type ParamsConsequence, type Personalization, type PromoteConsequenceObject, type QueryType, type Range, type RankingInfo, type ReRankingApplyFilter, type RecommendClient, type RecommendHit, type RecommendIndexSettings, type RecommendModels, type RecommendRule, type RecommendSearchParams, type RecommendationsHit, type RecommendationsHits, type RecommendationsRequest, type RecommendationsResults, type RecommendedForYou, type RecommendedForYouModel, type RecommendedForYouQuery, type Redirect, type RedirectRuleIndexData, type RedirectRuleIndexMetadata, type RedirectURL, type RelatedModel, type RelatedProducts, type RelatedQuery, type RemoveStopWords, type RemoveWordsIfNoResults, type RenderingContent, type RuleMetadata, type SearchPagination, type SearchParamsQuery, type SearchRecommendRulesParams, type SearchRecommendRulesProps, type SearchRecommendRulesResponse, type SnippetResult, type SnippetResultOption, type SortRemainingBy, type SupportedLanguage, type TagFilters, type TaskStatus, type TrendingFacetHit, type TrendingFacets, type TrendingFacetsModel, type TrendingFacetsQuery, type TrendingItems, type TrendingItemsModel, type TrendingItemsQuery, type TypoTolerance, type TypoToleranceEnum, type Value, apiClientVersion, recommendClient };
+export { type AdvancedSyntaxFeatures, type AlternativesAsExact, type AroundPrecision, type AroundRadius, type AroundRadiusAll, type AutoFacetFilter, type BaseIndexSettings, type BaseRecommendIndexSettings, type BaseRecommendRequest, type BaseRecommendSearchParams, type BaseSearchResponse, type BatchRecommendRulesProps, type BooleanString, type BoughtTogetherQuery, type Condition, type Consequence, type CustomDeleteProps, type CustomGetProps, type CustomPostProps, type CustomPutProps, type DeleteRecommendRuleProps, type DeletedAtResponse, type Distinct, type ErrorBase, type ExactOnSingleWordQuery, type Exhaustive, type FacetFilters, type FacetOrdering, type FacetStats, type FallbackParams, type FbtModel, type FrequentlyBoughtTogether, type GetRecommendRuleProps, type GetRecommendStatusProps, type GetRecommendTaskResponse, type GetRecommendationsParams, type GetRecommendationsResponse, type HideConsequenceObject, type HighlightResult, type HighlightResultOption, type IgnorePlurals, type IndexSettingsFacets, type LegacyGetRecommendationsParams, type LookingSimilar, type LookingSimilarModel, type LookingSimilarQuery, type MatchLevel, type MatchedGeoLocation, type NumericFilters, type OptionalFilters, type ParamsConsequence, type Personalization, type PromoteConsequenceObject, type QueryType, type Range, type RankingInfo, type ReRankingApplyFilter, type RecommendClient, type RecommendHit, type RecommendIndexSettings, type RecommendModels, type RecommendRule, type RecommendSearchParams, type RecommendUpdatedAtResponse, type RecommendationsHit, type RecommendationsHits, type RecommendationsRequest, type RecommendationsResults, type RecommendedForYou, type RecommendedForYouModel, type RecommendedForYouQuery, type Redirect, type RedirectRuleIndexData, type RedirectRuleIndexMetadata, type RedirectURL, type RelatedModel, type RelatedProducts, type RelatedQuery, type RemoveStopWords, type RemoveWordsIfNoResults, type RenderingContent, type RuleMetadata, type SearchPagination, type SearchParamsQuery, type SearchRecommendRulesParams, type SearchRecommendRulesProps, type SearchRecommendRulesResponse, type SnippetResult, type SnippetResultOption, type SortRemainingBy, type SupportedLanguage, type TagFilters, type TaskStatus, type TimeRange, type TrendingFacetHit, type TrendingFacets, type TrendingFacetsModel, type TrendingFacetsQuery, type TrendingItems, type TrendingItemsModel, type TrendingItemsQuery, type TypoTolerance, type TypoToleranceEnum, type Value, apiClientVersion, recommendClient };

package/dist/node.d.cts

@@ -3,6 +3,137 @@ import { CreateClientOptions, RequestOptions, ClientOptions } from '@algolia/cli
 
 type RecommendModels = 'bought-together' | 'related-products' | 'trending-facets' | 'trending-items';
 
+/**
+ * Condition that triggers the rule. If not specified, the rule is triggered for all recommendations.
+ */
+type Condition = {
+    /**
+     * 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;
+    /**
+     * 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;
+};
+
+/**
+ * Object ID of the recommendation you want to exclude.
+ */
+type HideConsequenceObject = {
+    /**
+     * Unique record identifier.
+     */
+    objectID?: string;
+};
+
+/**
+ * Facet attribute. Only recommendations with the same value (or only recommendations with a different value) as the original viewed item are included.
+ */
+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;
+};
+
+/**
+ * Filter or boost recommendations matching a facet filter.
+ */
+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[];
+};
+
+/**
+ * Object ID and position of the recommendation you want to pin.
+ */
+type PromoteConsequenceObject = {
+    /**
+     * Unique record identifier.
+     */
+    objectID?: string;
+    /**
+     * Index in the list of recommendations where to place this item.
+     */
+    position?: number;
+};
+
+/**
+ * Effect of the rule.
+ */
+type Consequence = {
+    /**
+     * Exclude items from recommendations.
+     */
+    hide?: HideConsequenceObject[];
+    /**
+     * Place items at specific positions in the list of recommendations.
+     */
+    promote?: PromoteConsequenceObject[];
+    params?: ParamsConsequence;
+};
+
+/**
+ * Rule metadata.
+ */
+type RuleMetadata = {
+    /**
+     * Date and time when the object was updated, in RFC 3339 format.
+     */
+    lastUpdate?: string;
+};
+
+type TimeRange = {
+    /**
+     * When the rule should start to be active, in Unix epoch time.
+     */
+    from: number;
+    /**
+     * When the rule should stop to be active, in Unix epoch time.
+     */
+    until: number;
+};
+
+/**
+ * Recommend rule.
+ */
+type RecommendRule = {
+    _metadata?: RuleMetadata;
+    /**
+     * 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;
+    /**
+     * Time periods when the rule is active.
+     */
+    validity?: TimeRange[];
+};
+
 /**
  * Range object with lower and upper values in meters to define custom ranges.
  */
@@ -631,6 +762,20 @@ type SearchRecommendRulesParams = {
     maxValuesPerFacet?: number;
 };
 
+/**
+ * Properties for the `batchRecommendRules` method.
+ */
+type BatchRecommendRulesProps = {
+    /**
+     * Name of the index on which to perform the operation.
+     */
+    indexName: string;
+    /**
+     * [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
+     */
+    model: RecommendModels;
+    recommendRule?: RecommendRule[];
+};
 /**
  * Properties for the `customDelete` method.
  */
@@ -1168,119 +1313,17 @@ type GetRecommendationsResponse = {
 };
 
 /**
- * Condition that triggers the rule. If not specified, the rule is triggered for all recommendations.
- */
-type Condition = {
-    /**
-     * 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;
-    /**
-     * 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;
-};
-
-/**
- * Object ID of the recommendation you want to exclude.
+ * Response, taskID, and update timestamp.
  */
-type HideConsequenceObject = {
+type RecommendUpdatedAtResponse = {
     /**
-     * Unique record identifier.
-     */
-    objectID?: string;
-};
-
-/**
- * Facet attribute. Only recommendations with the same value (or only recommendations with a different value) as the original viewed item are included.
- */
-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;
-};
-
-/**
- * Filter or boost recommendations matching a facet filter.
- */
-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[];
-};
-
-/**
- * Object ID and position of the recommendation you want to pin.
- */
-type PromoteConsequenceObject = {
-    /**
-     * Unique record identifier.
-     */
-    objectID?: string;
-    /**
-     * Index in the list of recommendations where to place this item.
-     */
-    position?: number;
-};
-
-/**
- * Effect of the rule.
- */
-type Consequence = {
-    /**
-     * Exclude items from recommendations.
-     */
-    hide?: HideConsequenceObject[];
-    /**
-     * Place items at specific positions in the list of recommendations.
+     * Unique identifier of a task.  A successful API response means that a task was added to a queue. It might not run immediately. You can check the task\'s progress with the [`task` operation](#tag/Indices/operation/getTask) and this `taskID`.
      */
-    promote?: PromoteConsequenceObject[];
-    params?: ParamsConsequence;
-};
-
-/**
- * Rule metadata.
- */
-type RuleMetadata = {
+    taskID: number;
     /**
      * Date and time when the object was updated, in RFC 3339 format.
      */
-    lastUpdate?: string;
-};
-
-/**
- * Recommend rule.
- */
-type RecommendRule = {
-    _metadata?: RuleMetadata;
-    /**
-     * 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;
+    updatedAt: string;
 };
 
 type SearchRecommendRulesResponse = {
@@ -1302,7 +1345,7 @@ type SearchRecommendRulesResponse = {
     nbPages: number;
 };
 
-declare const apiClientVersion = "5.6.1";
+declare const apiClientVersion = "5.7.0";
 declare function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
     transporter: _algolia_client_common.Transporter;
     /**
@@ -1333,6 +1376,19 @@ declare function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOptio
     setClientApiKey({ apiKey }: {
         apiKey: string;
     }): void;
+    /**
+     * Create or update a batch of Recommend Rules  Each Recommend Rule is created or updated, depending on whether a Recommend Rule with the same `objectID` already exists. You may also specify `true` for `clearExistingRules`, in which case the batch will atomically replace all the existing Recommend Rules.  Recommend Rules are similar to Search Rules, except that the conditions and consequences apply to a [source item](/doc/guides/algolia-recommend/overview/#recommend-models) instead of a query. The main differences are the following: - Conditions `pattern` and `anchoring` are unavailable. - Condition `filters` triggers if the source item matches the specified filters. - Condition `filters` accepts numeric filters. - Consequence `params` only covers filtering parameters. - Consequence `automaticFacetFilters` doesn\'t require a facet value placeholder (it tries to match the data source item\'s attributes instead).
+     *
+     * Required API Key ACLs:
+     * - editSettings.
+     *
+     * @param batchRecommendRules - The batchRecommendRules object.
+     * @param batchRecommendRules.indexName - Name of the index on which to perform the operation.
+     * @param batchRecommendRules.model - [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
+     * @param batchRecommendRules.recommendRule - The recommendRule object.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    batchRecommendRules({ indexName, model, recommendRule }: BatchRecommendRulesProps, requestOptions?: RequestOptions): Promise<RecommendUpdatedAtResponse>;
     /**
      * This method allow you to send requests to the Algolia REST API.
      *
@@ -1446,4 +1502,4 @@ type RecommendClient = ReturnType<typeof createRecommendClient>;
 
 declare function recommendClient(appId: string, apiKey: string, options?: ClientOptions): RecommendClient;
 
-export { type AdvancedSyntaxFeatures, type AlternativesAsExact, type AroundPrecision, type AroundRadius, type AroundRadiusAll, type AutoFacetFilter, type BaseIndexSettings, type BaseRecommendIndexSettings, type BaseRecommendRequest, type BaseRecommendSearchParams, type BaseSearchResponse, type BooleanString, type BoughtTogetherQuery, type Condition, type Consequence, type CustomDeleteProps, type CustomGetProps, type CustomPostProps, type CustomPutProps, type DeleteRecommendRuleProps, type DeletedAtResponse, type Distinct, type ErrorBase, type ExactOnSingleWordQuery, type Exhaustive, type FacetFilters, type FacetOrdering, type FacetStats, type FallbackParams, type FbtModel, type FrequentlyBoughtTogether, type GetRecommendRuleProps, type GetRecommendStatusProps, type GetRecommendTaskResponse, type GetRecommendationsParams, type GetRecommendationsResponse, type HideConsequenceObject, type HighlightResult, type HighlightResultOption, type IgnorePlurals, type IndexSettingsFacets, type LegacyGetRecommendationsParams, type LookingSimilar, type LookingSimilarModel, type LookingSimilarQuery, type MatchLevel, type MatchedGeoLocation, type NumericFilters, type OptionalFilters, type ParamsConsequence, type Personalization, type PromoteConsequenceObject, type QueryType, type Range, type RankingInfo, type ReRankingApplyFilter, type RecommendClient, type RecommendHit, type RecommendIndexSettings, type RecommendModels, type RecommendRule, type RecommendSearchParams, type RecommendationsHit, type RecommendationsHits, type RecommendationsRequest, type RecommendationsResults, type RecommendedForYou, type RecommendedForYouModel, type RecommendedForYouQuery, type Redirect, type RedirectRuleIndexData, type RedirectRuleIndexMetadata, type RedirectURL, type RelatedModel, type RelatedProducts, type RelatedQuery, type RemoveStopWords, type RemoveWordsIfNoResults, type RenderingContent, type RuleMetadata, type SearchPagination, type SearchParamsQuery, type SearchRecommendRulesParams, type SearchRecommendRulesProps, type SearchRecommendRulesResponse, type SnippetResult, type SnippetResultOption, type SortRemainingBy, type SupportedLanguage, type TagFilters, type TaskStatus, type TrendingFacetHit, type TrendingFacets, type TrendingFacetsModel, type TrendingFacetsQuery, type TrendingItems, type TrendingItemsModel, type TrendingItemsQuery, type TypoTolerance, type TypoToleranceEnum, type Value, apiClientVersion, recommendClient };
+export { type AdvancedSyntaxFeatures, type AlternativesAsExact, type AroundPrecision, type AroundRadius, type AroundRadiusAll, type AutoFacetFilter, type BaseIndexSettings, type BaseRecommendIndexSettings, type BaseRecommendRequest, type BaseRecommendSearchParams, type BaseSearchResponse, type BatchRecommendRulesProps, type BooleanString, type BoughtTogetherQuery, type Condition, type Consequence, type CustomDeleteProps, type CustomGetProps, type CustomPostProps, type CustomPutProps, type DeleteRecommendRuleProps, type DeletedAtResponse, type Distinct, type ErrorBase, type ExactOnSingleWordQuery, type Exhaustive, type FacetFilters, type FacetOrdering, type FacetStats, type FallbackParams, type FbtModel, type FrequentlyBoughtTogether, type GetRecommendRuleProps, type GetRecommendStatusProps, type GetRecommendTaskResponse, type GetRecommendationsParams, type GetRecommendationsResponse, type HideConsequenceObject, type HighlightResult, type HighlightResultOption, type IgnorePlurals, type IndexSettingsFacets, type LegacyGetRecommendationsParams, type LookingSimilar, type LookingSimilarModel, type LookingSimilarQuery, type MatchLevel, type MatchedGeoLocation, type NumericFilters, type OptionalFilters, type ParamsConsequence, type Personalization, type PromoteConsequenceObject, type QueryType, type Range, type RankingInfo, type ReRankingApplyFilter, type RecommendClient, type RecommendHit, type RecommendIndexSettings, type RecommendModels, type RecommendRule, type RecommendSearchParams, type RecommendUpdatedAtResponse, type RecommendationsHit, type RecommendationsHits, type RecommendationsRequest, type RecommendationsResults, type RecommendedForYou, type RecommendedForYouModel, type RecommendedForYouQuery, type Redirect, type RedirectRuleIndexData, type RedirectRuleIndexMetadata, type RedirectURL, type RelatedModel, type RelatedProducts, type RelatedQuery, type RemoveStopWords, type RemoveWordsIfNoResults, type RenderingContent, type RuleMetadata, type SearchPagination, type SearchParamsQuery, type SearchRecommendRulesParams, type SearchRecommendRulesProps, type SearchRecommendRulesResponse, type SnippetResult, type SnippetResultOption, type SortRemainingBy, type SupportedLanguage, type TagFilters, type TaskStatus, type TimeRange, type TrendingFacetHit, type TrendingFacets, type TrendingFacetsModel, type TrendingFacetsQuery, type TrendingItems, type TrendingItemsModel, type TrendingItemsQuery, type TypoTolerance, type TypoToleranceEnum, type Value, apiClientVersion, recommendClient };