feat(specs): add recommend batch rules endpoint (#3782) (generated) [skip ci]

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

Author: 4 people

clients/algoliasearch-client-csharp/algoliasearch/Clients/RecommendClient.cs

@@ -21,6 +21,40 @@ namespace Algolia.Search.Clients;
 /// </summary>
 public interface IRecommendClient
 {
+  /// <summary>
+  /// 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). 
+  /// </summary>
+  ///
+  /// Required API Key ACLs:
+  ///   - editSettings
+  /// <param name="indexName">Name of the index on which to perform the operation.</param>
+  /// <param name="model">[Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models). </param>
+  /// <param name="recommendRule"> (optional)</param>
+  /// <param name="options">Add extra http header or query parameters to Algolia.</param>
+  /// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
+  /// <exception cref="ArgumentException">Thrown when arguments are not correct</exception>
+  /// <exception cref="Algolia.Search.Exceptions.AlgoliaApiException">Thrown when the API call was rejected by Algolia</exception>
+  /// <exception cref="Algolia.Search.Exceptions.AlgoliaUnreachableHostException">Thrown when the client failed to call the endpoint</exception>
+  /// <returns>Task of RecommendUpdatedAtResponse</returns>
+  Task<RecommendUpdatedAtResponse> BatchRecommendRulesAsync(string indexName, RecommendModels model, List<RecommendRule> recommendRule = default, RequestOptions options = null, CancellationToken cancellationToken = default);
+
+  /// <summary>
+  /// 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).  (Synchronous version)
+  /// </summary>
+  ///
+  /// Required API Key ACLs:
+  ///   - editSettings
+  /// <param name="indexName">Name of the index on which to perform the operation.</param>
+  /// <param name="model">[Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models). </param>
+  /// <param name="recommendRule"> (optional)</param>
+  /// <param name="options">Add extra http header or query parameters to Algolia.</param>
+  /// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
+  /// <exception cref="ArgumentException">Thrown when arguments are not correct</exception>
+  /// <exception cref="Algolia.Search.Exceptions.AlgoliaApiException">Thrown when the API call was rejected by Algolia</exception>
+  /// <exception cref="Algolia.Search.Exceptions.AlgoliaUnreachableHostException">Thrown when the client failed to call the endpoint</exception>
+  /// <returns>RecommendUpdatedAtResponse</returns>
+  RecommendUpdatedAtResponse BatchRecommendRules(string indexName, RecommendModels model, List<RecommendRule> recommendRule = default, RequestOptions options = null, CancellationToken cancellationToken = default);
+
   /// <summary>
   /// This method allow you to send requests to the Algolia REST API.
   /// </summary>
@@ -374,6 +408,29 @@ public void SetClientApiKey(string apiKey)
 
 
 
+  /// <inheritdoc />
+  public async Task<RecommendUpdatedAtResponse> BatchRecommendRulesAsync(string indexName, RecommendModels model, List<RecommendRule> recommendRule = default, RequestOptions options = null, CancellationToken cancellationToken = default)
+  {
+
+    if (indexName == null)
+      throw new ArgumentException("Parameter `indexName` is required when calling `BatchRecommendRules`.");
+
+
+    var requestOptions = new InternalRequestOptions(options);
+
+    requestOptions.PathParameters.Add("indexName", QueryStringHelper.ParameterToString(indexName));
+    requestOptions.PathParameters.Add("model", QueryStringHelper.ParameterToString(model));
+
+    requestOptions.Data = recommendRule;
+    return await _transport.ExecuteRequestAsync<RecommendUpdatedAtResponse>(new HttpMethod("POST"), "/1/indexes/{indexName}/{model}/recommend/rules/batch", requestOptions, cancellationToken).ConfigureAwait(false);
+  }
+
+
+  /// <inheritdoc />
+  public RecommendUpdatedAtResponse BatchRecommendRules(string indexName, RecommendModels model, List<RecommendRule> recommendRule = default, RequestOptions options = null, CancellationToken cancellationToken = default) =>
+    AsyncHelper.RunSync(() => BatchRecommendRulesAsync(indexName, model, recommendRule, options, cancellationToken));
+
+
   /// <inheritdoc />
   public async Task<object> CustomDeleteAsync(string path, Dictionary<string, object> parameters = default, RequestOptions options = null, CancellationToken cancellationToken = default)
   {

clients/algoliasearch-client-csharp/algoliasearch/Models/Recommend/RecommendRule.cs

@@ -62,6 +62,13 @@ public RecommendRule()
   [JsonPropertyName("enabled")]
   public bool? Enabled { get; set; }
 
+  /// <summary>
+  /// Time periods when the rule is active.
+  /// </summary>
+  /// <value>Time periods when the rule is active.</value>
+  [JsonPropertyName("validity")]
+  public List<TimeRange> Validity { get; set; }
+
   /// <summary>
   /// Returns the string presentation of the object
   /// </summary>
@@ -76,6 +83,7 @@ public override string ToString()
     sb.Append("  Consequence: ").Append(Consequence).Append("\n");
     sb.Append("  Description: ").Append(Description).Append("\n");
     sb.Append("  Enabled: ").Append(Enabled).Append("\n");
+    sb.Append("  Validity: ").Append(Validity).Append("\n");
     sb.Append("}\n");
     return sb.ToString();
   }
@@ -107,7 +115,8 @@ public override bool Equals(object obj)
         (Condition == input.Condition || (Condition != null && Condition.Equals(input.Condition))) &&
         (Consequence == input.Consequence || (Consequence != null && Consequence.Equals(input.Consequence))) &&
         (Description == input.Description || (Description != null && Description.Equals(input.Description))) &&
-        (Enabled == input.Enabled || Enabled.Equals(input.Enabled));
+        (Enabled == input.Enabled || Enabled.Equals(input.Enabled)) &&
+        (Validity == input.Validity || Validity != null && input.Validity != null && Validity.SequenceEqual(input.Validity));
   }
 
   /// <summary>
@@ -140,6 +149,10 @@ public override int GetHashCode()
         hashCode = (hashCode * 59) + Description.GetHashCode();
       }
       hashCode = (hashCode * 59) + Enabled.GetHashCode();
+      if (Validity != null)
+      {
+        hashCode = (hashCode * 59) + Validity.GetHashCode();
+      }
       return hashCode;
     }
   }

clients/algoliasearch-client-csharp/algoliasearch/Models/Recommend/RecommendUpdatedAtResponse.cs

@@ -0,0 +1,108 @@
+//
+// 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.
+//
+using System;
+using System.Text;
+using System.Linq;
+using System.Text.Json.Serialization;
+using System.Collections.Generic;
+using Algolia.Search.Serializer;
+using System.Text.Json;
+
+namespace Algolia.Search.Models.Recommend;
+
+/// <summary>
+/// Response, taskID, and update timestamp.
+/// </summary>
+public partial class RecommendUpdatedAtResponse
+{
+  /// <summary>
+  /// Initializes a new instance of the RecommendUpdatedAtResponse class.
+  /// </summary>
+  [JsonConstructor]
+  public RecommendUpdatedAtResponse() { }
+  /// <summary>
+  /// Initializes a new instance of the RecommendUpdatedAtResponse class.
+  /// </summary>
+  /// <param name="taskID">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&#39;s progress with the [&#x60;task&#x60; operation](#tag/Indices/operation/getTask) and this &#x60;taskID&#x60;.  (required).</param>
+  /// <param name="updatedAt">Date and time when the object was updated, in RFC 3339 format. (required).</param>
+  public RecommendUpdatedAtResponse(long taskID, string updatedAt)
+  {
+    TaskID = taskID;
+    UpdatedAt = updatedAt ?? throw new ArgumentNullException(nameof(updatedAt));
+  }
+
+  /// <summary>
+  /// 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`. 
+  /// </summary>
+  /// <value>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`. </value>
+  [JsonPropertyName("taskID")]
+  public long TaskID { get; set; }
+
+  /// <summary>
+  /// Date and time when the object was updated, in RFC 3339 format.
+  /// </summary>
+  /// <value>Date and time when the object was updated, in RFC 3339 format.</value>
+  [JsonPropertyName("updatedAt")]
+  public string UpdatedAt { get; set; }
+
+  /// <summary>
+  /// Returns the string presentation of the object
+  /// </summary>
+  /// <returns>String presentation of the object</returns>
+  public override string ToString()
+  {
+    StringBuilder sb = new StringBuilder();
+    sb.Append("class RecommendUpdatedAtResponse {\n");
+    sb.Append("  TaskID: ").Append(TaskID).Append("\n");
+    sb.Append("  UpdatedAt: ").Append(UpdatedAt).Append("\n");
+    sb.Append("}\n");
+    return sb.ToString();
+  }
+
+  /// <summary>
+  /// Returns the JSON string presentation of the object
+  /// </summary>
+  /// <returns>JSON string presentation of the object</returns>
+  public virtual string ToJson()
+  {
+    return JsonSerializer.Serialize(this, JsonConfig.Options);
+  }
+
+  /// <summary>
+  /// Returns true if objects are equal
+  /// </summary>
+  /// <param name="obj">Object to be compared</param>
+  /// <returns>Boolean</returns>
+  public override bool Equals(object obj)
+  {
+    if (obj is not RecommendUpdatedAtResponse input)
+    {
+      return false;
+    }
+
+    return
+        (TaskID == input.TaskID || TaskID.Equals(input.TaskID)) &&
+        (UpdatedAt == input.UpdatedAt || (UpdatedAt != null && UpdatedAt.Equals(input.UpdatedAt)));
+  }
+
+  /// <summary>
+  /// Gets the hash code
+  /// </summary>
+  /// <returns>Hash code</returns>
+  public override int GetHashCode()
+  {
+    unchecked // Overflow is fine, just wrap
+    {
+      int hashCode = 41;
+      hashCode = (hashCode * 59) + TaskID.GetHashCode();
+      if (UpdatedAt != null)
+      {
+        hashCode = (hashCode * 59) + UpdatedAt.GetHashCode();
+      }
+      return hashCode;
+    }
+  }
+
+}
+

clients/algoliasearch-client-csharp/algoliasearch/Models/Recommend/TimeRange.cs

@@ -0,0 +1,105 @@
+//
+// 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.
+//
+using System;
+using System.Text;
+using System.Linq;
+using System.Text.Json.Serialization;
+using System.Collections.Generic;
+using Algolia.Search.Serializer;
+using System.Text.Json;
+
+namespace Algolia.Search.Models.Recommend;
+
+/// <summary>
+/// TimeRange
+/// </summary>
+public partial class TimeRange
+{
+  /// <summary>
+  /// Initializes a new instance of the TimeRange class.
+  /// </summary>
+  [JsonConstructor]
+  public TimeRange() { }
+  /// <summary>
+  /// Initializes a new instance of the TimeRange class.
+  /// </summary>
+  /// <param name="from">When the rule should start to be active, in Unix epoch time. (required).</param>
+  /// <param name="until">When the rule should stop to be active, in Unix epoch time. (required).</param>
+  public TimeRange(int from, int until)
+  {
+    From = from;
+    Until = until;
+  }
+
+  /// <summary>
+  /// When the rule should start to be active, in Unix epoch time.
+  /// </summary>
+  /// <value>When the rule should start to be active, in Unix epoch time.</value>
+  [JsonPropertyName("from")]
+  public int From { get; set; }
+
+  /// <summary>
+  /// When the rule should stop to be active, in Unix epoch time.
+  /// </summary>
+  /// <value>When the rule should stop to be active, in Unix epoch time.</value>
+  [JsonPropertyName("until")]
+  public int Until { get; set; }
+
+  /// <summary>
+  /// Returns the string presentation of the object
+  /// </summary>
+  /// <returns>String presentation of the object</returns>
+  public override string ToString()
+  {
+    StringBuilder sb = new StringBuilder();
+    sb.Append("class TimeRange {\n");
+    sb.Append("  From: ").Append(From).Append("\n");
+    sb.Append("  Until: ").Append(Until).Append("\n");
+    sb.Append("}\n");
+    return sb.ToString();
+  }
+
+  /// <summary>
+  /// Returns the JSON string presentation of the object
+  /// </summary>
+  /// <returns>JSON string presentation of the object</returns>
+  public virtual string ToJson()
+  {
+    return JsonSerializer.Serialize(this, JsonConfig.Options);
+  }
+
+  /// <summary>
+  /// Returns true if objects are equal
+  /// </summary>
+  /// <param name="obj">Object to be compared</param>
+  /// <returns>Boolean</returns>
+  public override bool Equals(object obj)
+  {
+    if (obj is not TimeRange input)
+    {
+      return false;
+    }
+
+    return
+        (From == input.From || From.Equals(input.From)) &&
+        (Until == input.Until || Until.Equals(input.Until));
+  }
+
+  /// <summary>
+  /// Gets the hash code
+  /// </summary>
+  /// <returns>Hash code</returns>
+  public override int GetHashCode()
+  {
+    unchecked // Overflow is fine, just wrap
+    {
+      int hashCode = 41;
+      hashCode = (hashCode * 59) + From.GetHashCode();
+      hashCode = (hashCode * 59) + Until.GetHashCode();
+      return hashCode;
+    }
+  }
+
+}
+

clients/algoliasearch-client-dart/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';

clients/algoliasearch-client-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: