feat(specs): add recommend batch rules endpoint (generated)

algolia/api-clients-automation#3782

Co-authored-by: algolia-bot <[email protected]>
Co-authored-by: Raed <[email protected]>
Co-authored-by: Pierre Millot <[email protected]>
Co-authored-by: Clément Vannicatte <[email protected]>

Author: 4 people

packages/algoliasearch/builds/models.ts

@@ -12,8 +12,8 @@ import type {
   AroundRadiusAll,
   AutomaticFacetFilter,
   AutomaticFacetFilters,
-  BaseSearchParams,
   BaseIndexSettings,
+  BaseSearchParams,
   BaseSearchParamsWithoutQuery,
   BaseSearchResponse,
   BooleanString,
@@ -42,8 +42,8 @@ import type {
   HighlightResultOption,
   IgnorePlurals,
   IndexSettingsAsSearchParams,
-  MatchLevel,
   MatchedGeoLocation,
+  MatchLevel,
   Mode,
   NumericFilters,
   OptionalFilters,
@@ -55,14 +55,14 @@ import type {
   QueryType,
   Range,
   RankingInfo,
-  ReRankingApplyFilter,
   Redirect,
-  RedirectRuleIndexMetadata,
   RedirectRuleIndexData,
+  RedirectRuleIndexMetadata,
   RedirectURL,
   RemoveStopWords,
   RemoveWordsIfNoResults,
   RenderingContent,
+  ReRankingApplyFilter,
   SearchPagination,
   SearchParams,
   SearchParamsObject,
@@ -74,6 +74,7 @@ import type {
   SupportedLanguage,
   TagFilters,
   TaskStatus,
+  TimeRange,
   TypoTolerance,
   TypoToleranceEnum,
   Value,
@@ -89,16 +90,19 @@ export * from '@algolia/client-analytics';
 export * from '@algolia/client-abtesting';
 
 export {
+  AbTestingRegion,
   AdvancedSyntaxFeatures,
   AlternativesAsExact,
+  AnalyticsRegion,
   Anchoring,
+  apiClientVersion,
   AroundPrecision,
   AroundRadius,
   AroundRadiusAll,
   AutomaticFacetFilter,
   AutomaticFacetFilters,
-  BaseSearchParams,
   BaseIndexSettings,
+  BaseSearchParams,
   BaseSearchParamsWithoutQuery,
   BaseSearchResponse,
   BooleanString,
@@ -127,8 +131,8 @@ export {
   HighlightResultOption,
   IgnorePlurals,
   IndexSettingsAsSearchParams,
-  MatchLevel,
   MatchedGeoLocation,
+  MatchLevel,
   Mode,
   NumericFilters,
   OptionalFilters,
@@ -140,32 +144,30 @@ export {
   QueryType,
   Range,
   RankingInfo,
-  ReRankingApplyFilter,
   Redirect,
-  RedirectRuleIndexMetadata,
   RedirectRuleIndexData,
+  RedirectRuleIndexMetadata,
   RedirectURL,
+  Region,
   RemoveStopWords,
   RemoveWordsIfNoResults,
   RenderingContent,
+  ReRankingApplyFilter,
+  SearchPagination,
   SearchParams,
   SearchParamsObject,
   SearchParamsQuery,
   SemanticSearch,
-  SearchPagination,
   SnippetResult,
   SnippetResultOption,
   SortRemainingBy,
   SupportedLanguage,
   TagFilters,
   TaskStatus,
+  TimeRange,
   TypoTolerance,
   TypoToleranceEnum,
   Value,
-  AnalyticsRegion,
-  AbTestingRegion,
-  Region,
-  apiClientVersion,
 };
 
 /**

packages/recommend/model/clientMethodProps.ts

@@ -1,9 +1,25 @@
 // 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 { RecommendModels } from './recommendModels';
+import type { RecommendRule } from './recommendRule';
 import type { RecommendationsRequest } from './recommendationsRequest';
 import type { SearchRecommendRulesParams } from './searchRecommendRulesParams';
 
+/**
+ * Properties for the `batchRecommendRules` method.
+ */
+export 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.
  */

packages/recommend/model/index.ts

@@ -53,6 +53,7 @@ export * from './recommendIndexSettings';
 export * from './recommendModels';
 export * from './recommendRule';
 export * from './recommendSearchParams';
+export * from './recommendUpdatedAtResponse';
 export * from './recommendationsHit';
 export * from './recommendationsHits';
 export * from './recommendationsRequest';
@@ -81,6 +82,7 @@ export * from './sortRemainingBy';
 export * from './supportedLanguage';
 export * from './tagFilters';
 export * from './taskStatus';
+export * from './timeRange';
 export * from './trendingFacetHit';
 export * from './trendingFacets';
 export * from './trendingFacetsModel';

packages/recommend/model/recommendRule.ts

@@ -3,6 +3,7 @@
 import type { Condition } from './condition';
 import type { Consequence } from './consequence';
 import type { RuleMetadata } from './ruleMetadata';
+import type { TimeRange } from './timeRange';
 
 /**
  * Recommend rule.
@@ -28,4 +29,9 @@ export type RecommendRule = {
    * 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[];
 };

packages/recommend/model/recommendUpdatedAtResponse.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.
+
+/**
+ * Response, taskID, and update timestamp.
+ */
+export type RecommendUpdatedAtResponse = {
+  /**
+   * 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`.
+   */
+  taskID: number;
+
+  /**
+   * Date and time when the object was updated, in RFC 3339 format.
+   */
+  updatedAt: string;
+};

packages/recommend/model/timeRange.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.
+
+export 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;
+};

packages/recommend/src/recommendClient.ts

@@ -11,6 +11,7 @@ import type {
 } from '@algolia/client-common';
 
 import type {
+  BatchRecommendRulesProps,
   CustomDeleteProps,
   CustomGetProps,
   CustomPostProps,
@@ -26,6 +27,7 @@ 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 { RecommendUpdatedAtResponse } from '../model/recommendUpdatedAtResponse';
 import type { SearchRecommendRulesResponse } from '../model/searchRecommendRulesResponse';
 
 export const apiClientVersion = '5.6.1';
@@ -139,6 +141,47 @@ export function createRecommendClient({
       }
     },
 
+    /**
+     * 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> {
+      if (!indexName) {
+        throw new Error('Parameter `indexName` is required when calling `batchRecommendRules`.');
+      }
+
+      if (!model) {
+        throw new Error('Parameter `model` is required when calling `batchRecommendRules`.');
+      }
+
+      const requestPath = '/1/indexes/{indexName}/{model}/recommend/rules/batch'
+        .replace('{indexName}', encodeURIComponent(indexName))
+        .replace('{model}', encodeURIComponent(model));
+      const headers: Headers = {};
+      const queryParameters: QueryParameters = {};
+
+      const request: Request = {
+        method: 'POST',
+        path: requestPath,
+        queryParameters,
+        headers,
+        data: recommendRule ? recommendRule : {},
+      };
+
+      return transporter.request(request, requestOptions);
+    },
+
     /**
      * This method allow you to send requests to the Algolia REST API.
      *