feat(specs): document runMetadata parameter (generated)

algolia/api-clients-automation#5087

Co-authored-by: algolia-bot <[email protected]>
Co-authored-by: Devin Beeuwkes <[email protected]>

Author: algolia-bot

src/main/scala/algoliasearch/api/IngestionClient.scala

@@ -44,6 +44,7 @@ import algoliasearch.ingestion.RunSortKeys._
 import algoliasearch.ingestion.RunSourcePayload
 import algoliasearch.ingestion.RunSourceResponse
 import algoliasearch.ingestion.RunStatus._
+import algoliasearch.ingestion.RunTaskPayload
 import algoliasearch.ingestion.RunType._
 import algoliasearch.ingestion.Source
 import algoliasearch.ingestion.SourceCreate
@@ -1338,16 +1339,20 @@ class IngestionClient(
     *
     * @param taskID
     *   Unique identifier of a task.
+    * @param runTaskPayload
     */
-  def runTask(taskID: String, requestOptions: Option[RequestOptions] = None)(implicit
-      ec: ExecutionContext
-  ): Future[RunResponse] = Future {
+  def runTask(
+      taskID: String,
+      runTaskPayload: Option[RunTaskPayload] = None,
+      requestOptions: Option[RequestOptions] = None
+  )(implicit ec: ExecutionContext): Future[RunResponse] = Future {
     requireNotNull(taskID, "Parameter `taskID` is required when calling `runTask`.")
 
     val request = HttpRequest
       .builder()
       .withMethod("POST")
       .withPath(s"/2/tasks/${escape(taskID)}/run")
+      .withBody(runTaskPayload)
       .build()
     execute[RunResponse](request, requestOptions)
   }
@@ -1364,16 +1369,20 @@ class IngestionClient(
     *
     * @param taskID
     *   Unique identifier of a task.
+    * @param runTaskPayload
     */
-  def runTaskV1(taskID: String, requestOptions: Option[RequestOptions] = None)(implicit
-      ec: ExecutionContext
-  ): Future[RunResponse] = Future {
+  def runTaskV1(
+      taskID: String,
+      runTaskPayload: Option[RunTaskPayload] = None,
+      requestOptions: Option[RequestOptions] = None
+  )(implicit ec: ExecutionContext): Future[RunResponse] = Future {
     requireNotNull(taskID, "Parameter `taskID` is required when calling `runTaskV1`.")
 
     val request = HttpRequest
       .builder()
       .withMethod("POST")
       .withPath(s"/1/tasks/${escape(taskID)}/run")
+      .withBody(runTaskPayload)
       .build()
     execute[RunResponse](request, requestOptions)
   }

src/main/scala/algoliasearch/ingestion/RunSourcePayload.scala

@@ -29,10 +29,13 @@ import algoliasearch.ingestion.EntityType._
   *   List of index names to exclude in reindex/update.
   * @param entityIDs
   *   List of entityIDs to update.
+  * @param runMetadata
+  *   Additional information that will be passed to the created runs.
   */
 case class RunSourcePayload(
     indexToInclude: Option[Seq[String]] = scala.None,
     indexToExclude: Option[Seq[String]] = scala.None,
     entityIDs: Option[Seq[String]] = scala.None,
-    entityType: Option[EntityType] = scala.None
+    entityType: Option[EntityType] = scala.None,
+    runMetadata: Option[Map[String, Any]] = scala.None
 )

src/main/scala/algoliasearch/ingestion/RunTaskPayload.scala

@@ -0,0 +1,29 @@
+/** Ingestion API The Ingestion API lets you connect third-party services and platforms with Algolia and schedule tasks
+  * to ingest your data. The Ingestion API powers the no-code [data
+  * connectors](https://dashboard.algolia.com/connectors). ## Base URLs The base URLs for requests to the Ingestion API
+  * are: - `https://data.us.algolia.com` - `https://data.eu.algolia.com` Use the URL that matches your [analytics
+  * region](https://dashboard.algolia.com/account/infrastructure/analytics). **All requests must use HTTPS.** ##
+  * Authentication To authenticate your API requests, add these headers: - `x-algolia-application-id`. Your Algolia
+  * application ID. - `x-algolia-api-key`. An API key with the necessary permissions to make the request. The required
+  * access control list (ACL) to make a request is listed in each endpoint's reference. You can find your application ID
+  * and API key in the [Algolia dashboard](https://dashboard.algolia.com/account). ## Request format Request bodies must
+  * be JSON objects. ## Response status and errors Response bodies are JSON objects. Successful responses return a `2xx`
+  * status. Client errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error responses have a
+  * `message` property with more information. ## Version The current version of the Ingestion API is version 1, as
+  * indicated by the `/1/` in each endpoint's URL.
+  *
+  * The version of the OpenAPI document: 1.0.0
+  *
+  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+  * https://openapi-generator.tech Do not edit the class manually.
+  */
+package algoliasearch.ingestion
+
+/** RunTaskPayload
+  *
+  * @param runMetadata
+  *   Additional information that will be passed to the created run.
+  */
+case class RunTaskPayload(
+    runMetadata: Option[Map[String, Any]] = scala.None
+)