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

lib/Api/RecommendClient.php

@@ -109,6 +109,60 @@ public function setClientApiKey($apiKey)
         $this->config->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
+     *
+     * @param string $indexName      Name of the index on which to perform the operation. (required)
+     * @param array  $model          [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models). (required)
+     * @param array  $recommendRule  recommendRule (optional)
+     * @param array  $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
+     *
+     * @return \Algolia\AlgoliaSearch\Model\Recommend\RecommendUpdatedAtResponse|array<string, mixed>
+     */
+    public function batchRecommendRules($indexName, $model, $recommendRule = null, $requestOptions = [])
+    {
+        // verify the required parameter 'indexName' is set
+        if (!isset($indexName)) {
+            throw new \InvalidArgumentException(
+                'Parameter `indexName` is required when calling `batchRecommendRules`.'
+            );
+        }
+        // verify the required parameter 'model' is set
+        if (!isset($model)) {
+            throw new \InvalidArgumentException(
+                'Parameter `model` is required when calling `batchRecommendRules`.'
+            );
+        }
+
+        $resourcePath = '/1/indexes/{indexName}/{model}/recommend/rules/batch';
+        $queryParameters = [];
+        $headers = [];
+        $httpBody = isset($recommendRule) ? $recommendRule : [];
+
+        // path params
+        if (null !== $indexName) {
+            $resourcePath = str_replace(
+                '{indexName}',
+                ObjectSerializer::toPathValue($indexName),
+                $resourcePath
+            );
+        }
+
+        // path params
+        if (null !== $model) {
+            $resourcePath = str_replace(
+                '{model}',
+                ObjectSerializer::toPathValue($model),
+                $resourcePath
+            );
+        }
+
+        return $this->sendRequest('POST', $resourcePath, $headers, $queryParameters, $httpBody, $requestOptions);
+    }
+
     /**
      * This method allow you to send requests to the Algolia REST API.
      *

lib/Model/Recommend/RecommendRule.php

@@ -28,6 +28,7 @@ class RecommendRule extends AbstractModel implements ModelInterface, \ArrayAcces
         'consequence' => '\Algolia\AlgoliaSearch\Model\Recommend\Consequence',
         'description' => 'string',
         'enabled' => 'bool',
+        'validity' => '\Algolia\AlgoliaSearch\Model\Recommend\TimeRange[]',
     ];
 
     /**
@@ -42,6 +43,7 @@ class RecommendRule extends AbstractModel implements ModelInterface, \ArrayAcces
         'consequence' => null,
         'description' => null,
         'enabled' => null,
+        'validity' => null,
     ];
 
     /**
@@ -57,6 +59,7 @@ class RecommendRule extends AbstractModel implements ModelInterface, \ArrayAcces
         'consequence' => 'consequence',
         'description' => 'description',
         'enabled' => 'enabled',
+        'validity' => 'validity',
     ];
 
     /**
@@ -71,6 +74,7 @@ class RecommendRule extends AbstractModel implements ModelInterface, \ArrayAcces
         'consequence' => 'setConsequence',
         'description' => 'setDescription',
         'enabled' => 'setEnabled',
+        'validity' => 'setValidity',
     ];
 
     /**
@@ -85,6 +89,7 @@ class RecommendRule extends AbstractModel implements ModelInterface, \ArrayAcces
         'consequence' => 'getConsequence',
         'description' => 'getDescription',
         'enabled' => 'getEnabled',
+        'validity' => 'getValidity',
     ];
 
     /**
@@ -119,6 +124,9 @@ public function __construct(?array $data = null)
         if (isset($data['enabled'])) {
             $this->container['enabled'] = $data['enabled'];
         }
+        if (isset($data['validity'])) {
+            $this->container['validity'] = $data['validity'];
+        }
     }
 
     /**
@@ -337,6 +345,30 @@ public function setEnabled($enabled)
         return $this;
     }
 
+    /**
+     * Gets validity.
+     *
+     * @return null|\Algolia\AlgoliaSearch\Model\Recommend\TimeRange[]
+     */
+    public function getValidity()
+    {
+        return $this->container['validity'] ?? null;
+    }
+
+    /**
+     * Sets validity.
+     *
+     * @param null|\Algolia\AlgoliaSearch\Model\Recommend\TimeRange[] $validity time periods when the rule is active
+     *
+     * @return self
+     */
+    public function setValidity($validity)
+    {
+        $this->container['validity'] = $validity;
+
+        return $this;
+    }
+
     /**
      * Returns true if offset exists. False otherwise.
      *