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

client/src/commonMain/kotlin/com/algolia/client/api/RecommendClient.kt

@@ -31,6 +31,29 @@ public class RecommendClient(
     ).apply { shuffle() }
   }
 
+  /**
+   * 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 indexName Name of the index on which to perform the operation.
+   * @param model [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
+   * @param recommendRule
+   * @param requestOptions additional request configuration.
+   */
+  public suspend fun batchRecommendRules(indexName: String, model: RecommendModels, recommendRule: List<RecommendRule>? = null, requestOptions: RequestOptions? = null): RecommendUpdatedAtResponse {
+    require(indexName.isNotBlank()) { "Parameter `indexName` is required when calling `batchRecommendRules`." }
+    val requestConfig = RequestConfig(
+      method = RequestMethod.POST,
+      path = listOf("1", "indexes", "$indexName", "$model", "recommend", "rules", "batch"),
+      body = recommendRule,
+    )
+    return requester.execute(
+      requestConfig = requestConfig,
+      requestOptions = requestOptions,
+    )
+  }
+
   /**
    * This method allow you to send requests to the Algolia REST API.
    * @param path Path of the endpoint, anything after \"/1\" must be specified.

client/src/commonMain/kotlin/com/algolia/client/model/recommend/RecommendRule.kt

@@ -13,6 +13,7 @@ import kotlinx.serialization.json.*
  * @param consequence
  * @param description Description of the rule's purpose. This can be helpful for display in the Algolia dashboard.
  * @param enabled Indicates whether to enable the rule. If it isn't enabled, it isn't applied at query time.
+ * @param validity Time periods when the rule is active.
  */
 @Serializable
 public data class RecommendRule(
@@ -31,4 +32,7 @@ public data class RecommendRule(
 
   /** Indicates whether to enable the rule. If it isn't enabled, it isn't applied at query time. */
   @SerialName(value = "enabled") val enabled: Boolean? = null,
+
+  /** Time periods when the rule is active. */
+  @SerialName(value = "validity") val validity: List<TimeRange>? = null,
 )

client/src/commonMain/kotlin/com/algolia/client/model/recommend/RecommendUpdatedAtResponse.kt

@@ -0,0 +1,21 @@
+/** 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. */
+package com.algolia.client.model.recommend
+
+import kotlinx.serialization.*
+import kotlinx.serialization.json.*
+
+/**
+ * Response, taskID, and update timestamp.
+ *
+ * @param 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's progress with the [`task` operation](#tag/Indices/operation/getTask) and this `taskID`.
+ * @param updatedAt Date and time when the object was updated, in RFC 3339 format.
+ */
+@Serializable
+public data class 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`.  */
+  @SerialName(value = "taskID") val taskID: Long,
+
+  /** Date and time when the object was updated, in RFC 3339 format. */
+  @SerialName(value = "updatedAt") val updatedAt: String,
+)

client/src/commonMain/kotlin/com/algolia/client/model/recommend/TimeRange.kt

@@ -0,0 +1,21 @@
+/** 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. */
+package com.algolia.client.model.recommend
+
+import kotlinx.serialization.*
+import kotlinx.serialization.json.*
+
+/**
+ * TimeRange
+ *
+ * @param from When the rule should start to be active, in Unix epoch time.
+ * @param until When the rule should stop to be active, in Unix epoch time.
+ */
+@Serializable
+public data class TimeRange(
+
+  /** When the rule should start to be active, in Unix epoch time. */
+  @SerialName(value = "from") val from: Int,
+
+  /** When the rule should stop to be active, in Unix epoch time. */
+  @SerialName(value = "until") val until: Int,
+)