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/client_recommend/lib/algolia_client_recommend.dart

@@ -49,6 +49,7 @@ export 'src/model/recommend_index_settings.dart';
 export 'src/model/recommend_models.dart';
 export 'src/model/recommend_rule.dart';
 export 'src/model/recommend_search_params.dart';
+export 'src/model/recommend_updated_at_response.dart';
 export 'src/model/recommendations_hits.dart';
 export 'src/model/recommendations_results.dart';
 export 'src/model/recommended_for_you.dart';
@@ -72,6 +73,7 @@ export 'src/model/snippet_result_option.dart';
 export 'src/model/sort_remaining_by.dart';
 export 'src/model/supported_language.dart';
 export 'src/model/task_status.dart';
+export 'src/model/time_range.dart';
 export 'src/model/trending_facet_hit.dart';
 export 'src/model/trending_facets.dart';
 export 'src/model/trending_facets_model.dart';

packages/client_recommend/lib/src/api/recommend_client.dart

@@ -10,6 +10,7 @@ import 'package:algolia_client_recommend/src/model/get_recommendations_params.da
 import 'package:algolia_client_recommend/src/model/get_recommendations_response.dart';
 import 'package:algolia_client_recommend/src/model/recommend_models.dart';
 import 'package:algolia_client_recommend/src/model/recommend_rule.dart';
+import 'package:algolia_client_recommend/src/model/recommend_updated_at_response.dart';
 import 'package:algolia_client_recommend/src/model/search_recommend_rules_params.dart';
 import 'package:algolia_client_recommend/src/model/search_recommend_rules_response.dart';
 
@@ -49,6 +50,45 @@ final class RecommendClient implements ApiClient {
     _retryStrategy.requester.setClientApiKey(apiKey);
   }
 
+  /// 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
+  ///
+  /// Parameters:
+  /// * [indexName] Name of the index on which to perform the operation.
+  /// * [model] [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
+  /// * [recommendRule]
+  /// * [requestOptions] additional request configuration.
+  Future<RecommendUpdatedAtResponse> batchRecommendRules({
+    required String indexName,
+    required RecommendModels model,
+    List<RecommendRule>? recommendRule,
+    RequestOptions? requestOptions,
+  }) async {
+    assert(
+      indexName.isNotEmpty,
+      'Parameter `indexName` is required when calling `batchRecommendRules`.',
+    );
+    final request = ApiRequest(
+      method: RequestMethod.post,
+      path: r'/1/indexes/{indexName}/{model}/recommend/rules/batch'
+          .replaceAll(
+              '{' r'indexName' '}', Uri.encodeComponent(indexName.toString()))
+          .replaceAll('{' r'model' '}', Uri.encodeComponent(model.toString())),
+      body: recommendRule,
+    );
+    final response = await _retryStrategy.execute(
+      request: request,
+      options: requestOptions,
+    );
+    return deserialize<RecommendUpdatedAtResponse, RecommendUpdatedAtResponse>(
+      response,
+      'RecommendUpdatedAtResponse',
+      growable: true,
+    );
+  }
+
   /// This method allow you to send requests to the Algolia REST API.
   ///
   /// Parameters:

packages/client_recommend/lib/src/deserialize.dart

@@ -42,6 +42,7 @@ import 'package:algolia_client_recommend/src/model/recommend_index_settings.dart
 import 'package:algolia_client_recommend/src/model/recommend_models.dart';
 import 'package:algolia_client_recommend/src/model/recommend_rule.dart';
 import 'package:algolia_client_recommend/src/model/recommend_search_params.dart';
+import 'package:algolia_client_recommend/src/model/recommend_updated_at_response.dart';
 import 'package:algolia_client_recommend/src/model/recommendations_hits.dart';
 import 'package:algolia_client_recommend/src/model/recommendations_results.dart';
 import 'package:algolia_client_recommend/src/model/recommended_for_you.dart';
@@ -65,6 +66,7 @@ import 'package:algolia_client_recommend/src/model/snippet_result_option.dart';
 import 'package:algolia_client_recommend/src/model/sort_remaining_by.dart';
 import 'package:algolia_client_recommend/src/model/supported_language.dart';
 import 'package:algolia_client_recommend/src/model/task_status.dart';
+import 'package:algolia_client_recommend/src/model/time_range.dart';
 import 'package:algolia_client_recommend/src/model/trending_facet_hit.dart';
 import 'package:algolia_client_recommend/src/model/trending_facets.dart';
 import 'package:algolia_client_recommend/src/model/trending_facets_model.dart';
@@ -208,6 +210,9 @@ ReturnType deserialize<ReturnType, BaseType>(dynamic value, String targetType,
     case 'RecommendSearchParams':
       return RecommendSearchParams.fromJson(value as Map<String, dynamic>)
           as ReturnType;
+    case 'RecommendUpdatedAtResponse':
+      return RecommendUpdatedAtResponse.fromJson(value as Map<String, dynamic>)
+          as ReturnType;
     case 'RecommendationsHits':
       return RecommendationsHits.fromJson(value as Map<String, dynamic>)
           as ReturnType;
@@ -267,6 +272,8 @@ ReturnType deserialize<ReturnType, BaseType>(dynamic value, String targetType,
       return SupportedLanguage.fromJson(value) as ReturnType;
     case 'TaskStatus':
       return TaskStatus.fromJson(value) as ReturnType;
+    case 'TimeRange':
+      return TimeRange.fromJson(value as Map<String, dynamic>) as ReturnType;
     case 'TrendingFacetHit':
       return TrendingFacetHit.fromJson(value as Map<String, dynamic>)
           as ReturnType;

packages/client_recommend/lib/src/model/recommend_rule.dart

@@ -1,6 +1,7 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 // ignore_for_file: unused_element
 import 'package:algolia_client_recommend/src/model/condition.dart';
+import 'package:algolia_client_recommend/src/model/time_range.dart';
 import 'package:algolia_client_recommend/src/model/rule_metadata.dart';
 import 'package:algolia_client_recommend/src/model/consequence.dart';
 
@@ -18,6 +19,7 @@ final class RecommendRule {
     this.consequence,
     this.description,
     this.enabled,
+    this.validity,
   });
 
   @JsonKey(name: r'_metadata')
@@ -41,6 +43,10 @@ final class RecommendRule {
   @JsonKey(name: r'enabled')
   final bool? enabled;
 
+  /// Time periods when the rule is active.
+  @JsonKey(name: r'validity')
+  final List<TimeRange>? validity;
+
   @override
   bool operator ==(Object other) =>
       identical(this, other) ||
@@ -50,7 +56,8 @@ final class RecommendRule {
           other.condition == condition &&
           other.consequence == consequence &&
           other.description == description &&
-          other.enabled == enabled;
+          other.enabled == enabled &&
+          other.validity == validity;
 
   @override
   int get hashCode =>
@@ -59,7 +66,8 @@ final class RecommendRule {
       condition.hashCode +
       consequence.hashCode +
       description.hashCode +
-      enabled.hashCode;
+      enabled.hashCode +
+      validity.hashCode;
 
   factory RecommendRule.fromJson(Map<String, dynamic> json) =>
       _$RecommendRuleFromJson(json);

packages/client_recommend/lib/src/model/recommend_rule.g.dart

@@ -0,0 +1,43 @@
+// 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.
+// ignore_for_file: unused_element
+
+import 'package:json_annotation/json_annotation.dart';
+
+part 'recommend_updated_at_response.g.dart';
+
+@JsonSerializable()
+final class RecommendUpdatedAtResponse {
+  /// Returns a new [RecommendUpdatedAtResponse] instance.
+  const RecommendUpdatedAtResponse({
+    required this.taskID,
+    required this.updatedAt,
+  });
+
+  /// 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`.
+  @JsonKey(name: r'taskID')
+  final int taskID;
+
+  /// Date and time when the object was updated, in RFC 3339 format.
+  @JsonKey(name: r'updatedAt')
+  final String updatedAt;
+
+  @override
+  bool operator ==(Object other) =>
+      identical(this, other) ||
+      other is RecommendUpdatedAtResponse &&
+          other.taskID == taskID &&
+          other.updatedAt == updatedAt;
+
+  @override
+  int get hashCode => taskID.hashCode + updatedAt.hashCode;
+
+  factory RecommendUpdatedAtResponse.fromJson(Map<String, dynamic> json) =>
+      _$RecommendUpdatedAtResponseFromJson(json);
+
+  Map<String, dynamic> toJson() => _$RecommendUpdatedAtResponseToJson(this);
+
+  @override
+  String toString() {
+    return toJson().toString();
+  }
+}

packages/client_recommend/lib/src/model/recommend_updated_at_response.dart

@@ -0,0 +1,41 @@
+// 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.
+// ignore_for_file: unused_element
+
+import 'package:json_annotation/json_annotation.dart';
+
+part 'time_range.g.dart';
+
+@JsonSerializable()
+final class TimeRange {
+  /// Returns a new [TimeRange] instance.
+  const TimeRange({
+    required this.from,
+    required this.until,
+  });
+
+  /// When the rule should start to be active, in Unix epoch time.
+  @JsonKey(name: r'from')
+  final int from;
+
+  /// When the rule should stop to be active, in Unix epoch time.
+  @JsonKey(name: r'until')
+  final int until;
+
+  @override
+  bool operator ==(Object other) =>
+      identical(this, other) ||
+      other is TimeRange && other.from == from && other.until == until;
+
+  @override
+  int get hashCode => from.hashCode + until.hashCode;
+
+  factory TimeRange.fromJson(Map<String, dynamic> json) =>
+      _$TimeRangeFromJson(json);
+
+  Map<String, dynamic> toJson() => _$TimeRangeToJson(this);
+
+  @override
+  String toString() {
+    return toJson().toString();
+  }
+}