feat(specs): add new ingestion property for push (#5007) (generated) [skip ci]

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

Author: algolia-bot

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

@@ -1695,6 +1695,7 @@ ListTransformationsResponse ListTransformations(
   /// <param name="indexName">Name of the index on which to perform the operation.</param>
   /// <param name="pushTaskPayload"></param>
   /// <param name="watch">When provided, the push operation will be synchronous and the API will wait for the ingestion to be finished before responding. (optional)</param>
+  /// <param name="referenceIndexName">This is required when targeting an index that does not have a push connector setup (e.g. a tmp index), but you wish to attach another index's transformation to it (e.g. the source index name). (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>
@@ -1705,6 +1706,7 @@ Task<WatchResponse> PushAsync(
     string indexName,
     PushTaskPayload pushTaskPayload,
     bool? watch = default,
+    string referenceIndexName = default,
     RequestOptions options = null,
     CancellationToken cancellationToken = default
   );
@@ -1720,6 +1722,7 @@ Task<WatchResponse> PushAsync(
   /// <param name="indexName">Name of the index on which to perform the operation.</param>
   /// <param name="pushTaskPayload"></param>
   /// <param name="watch">When provided, the push operation will be synchronous and the API will wait for the ingestion to be finished before responding. (optional)</param>
+  /// <param name="referenceIndexName">This is required when targeting an index that does not have a push connector setup (e.g. a tmp index), but you wish to attach another index's transformation to it (e.g. the source index name). (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>
@@ -1730,6 +1733,7 @@ WatchResponse Push(
     string indexName,
     PushTaskPayload pushTaskPayload,
     bool? watch = default,
+    string referenceIndexName = default,
     RequestOptions options = null,
     CancellationToken cancellationToken = default
   );
@@ -4161,6 +4165,7 @@ public async Task<WatchResponse> PushAsync(
     string indexName,
     PushTaskPayload pushTaskPayload,
     bool? watch = default,
+    string referenceIndexName = default,
     RequestOptions options = null,
     CancellationToken cancellationToken = default
   )
@@ -4176,6 +4181,7 @@ public async Task<WatchResponse> PushAsync(
     requestOptions.PathParameters.Add("indexName", QueryStringHelper.ParameterToString(indexName));
 
     requestOptions.AddQueryParameter("watch", watch);
+    requestOptions.AddQueryParameter("referenceIndexName", referenceIndexName);
     requestOptions.Data = pushTaskPayload;
     requestOptions.ReadTimeout ??= TimeSpan.FromMilliseconds(180000);
     requestOptions.WriteTimeout ??= TimeSpan.FromMilliseconds(180000);
@@ -4195,11 +4201,12 @@ public WatchResponse Push(
     string indexName,
     PushTaskPayload pushTaskPayload,
     bool? watch = default,
+    string referenceIndexName = default,
     RequestOptions options = null,
     CancellationToken cancellationToken = default
   ) =>
     AsyncHelper.RunSync(() =>
-      PushAsync(indexName, pushTaskPayload, watch, options, cancellationToken)
+      PushAsync(indexName, pushTaskPayload, watch, referenceIndexName, options, cancellationToken)
     );
 
   /// <inheritdoc />

clients/algoliasearch-client-go/algolia/ingestion/api_ingestion.go

@@ -3133,6 +3133,9 @@ public CompletableFuture<ListTransformationsResponse> listTransformationsAsync()
    * @param pushTaskPayload (required)
    * @param watch When provided, the push operation will be synchronous and the API will wait for
    *     the ingestion to be finished before responding. (optional)
+   * @param referenceIndexName This is required when targeting an index that does not have a push
+   *     connector setup (e.g. a tmp index), but you wish to attach another index's transformation
+   *     to it (e.g. the source index name). (optional)
    * @param requestOptions The requestOptions to send along with the query, they will be merged with
    *     the transporter requestOptions.
    * @throws AlgoliaRuntimeException If it fails to process the API call
@@ -3141,9 +3144,10 @@ public WatchResponse push(
     @Nonnull String indexName,
     @Nonnull PushTaskPayload pushTaskPayload,
     Boolean watch,
+    String referenceIndexName,
     @Nullable RequestOptions requestOptions
   ) throws AlgoliaRuntimeException {
-    return LaunderThrowable.await(pushAsync(indexName, pushTaskPayload, watch, requestOptions));
+    return LaunderThrowable.await(pushAsync(indexName, pushTaskPayload, watch, referenceIndexName, requestOptions));
   }
 
   /**
@@ -3160,11 +3164,14 @@ public WatchResponse push(
    * @param pushTaskPayload (required)
    * @param watch When provided, the push operation will be synchronous and the API will wait for
    *     the ingestion to be finished before responding. (optional)
+   * @param referenceIndexName This is required when targeting an index that does not have a push
+   *     connector setup (e.g. a tmp index), but you wish to attach another index's transformation
+   *     to it (e.g. the source index name). (optional)
    * @throws AlgoliaRuntimeException If it fails to process the API call
    */
-  public WatchResponse push(@Nonnull String indexName, @Nonnull PushTaskPayload pushTaskPayload, Boolean watch)
+  public WatchResponse push(@Nonnull String indexName, @Nonnull PushTaskPayload pushTaskPayload, Boolean watch, String referenceIndexName)
     throws AlgoliaRuntimeException {
-    return this.push(indexName, pushTaskPayload, watch, null);
+    return this.push(indexName, pushTaskPayload, watch, referenceIndexName, null);
   }
 
   /**
@@ -3185,7 +3192,7 @@ public WatchResponse push(@Nonnull String indexName, @Nonnull PushTaskPayload pu
    */
   public WatchResponse push(@Nonnull String indexName, @Nonnull PushTaskPayload pushTaskPayload, @Nullable RequestOptions requestOptions)
     throws AlgoliaRuntimeException {
-    return this.push(indexName, pushTaskPayload, null, requestOptions);
+    return this.push(indexName, pushTaskPayload, null, null, requestOptions);
   }
 
   /**
@@ -3203,7 +3210,7 @@ public WatchResponse push(@Nonnull String indexName, @Nonnull PushTaskPayload pu
    * @throws AlgoliaRuntimeException If it fails to process the API call
    */
   public WatchResponse push(@Nonnull String indexName, @Nonnull PushTaskPayload pushTaskPayload) throws AlgoliaRuntimeException {
-    return this.push(indexName, pushTaskPayload, null, null);
+    return this.push(indexName, pushTaskPayload, null, null, null);
   }
 
   /**
@@ -3220,6 +3227,9 @@ public WatchResponse push(@Nonnull String indexName, @Nonnull PushTaskPayload pu
    * @param pushTaskPayload (required)
    * @param watch When provided, the push operation will be synchronous and the API will wait for
    *     the ingestion to be finished before responding. (optional)
+   * @param referenceIndexName This is required when targeting an index that does not have a push
+   *     connector setup (e.g. a tmp index), but you wish to attach another index's transformation
+   *     to it (e.g. the source index name). (optional)
    * @param requestOptions The requestOptions to send along with the query, they will be merged with
    *     the transporter requestOptions.
    * @throws AlgoliaRuntimeException If it fails to process the API call
@@ -3228,6 +3238,7 @@ public CompletableFuture<WatchResponse> pushAsync(
     @Nonnull String indexName,
     @Nonnull PushTaskPayload pushTaskPayload,
     Boolean watch,
+    String referenceIndexName,
     @Nullable RequestOptions requestOptions
   ) throws AlgoliaRuntimeException {
     Parameters.requireNonNull(indexName, "Parameter `indexName` is required when calling `push`.");
@@ -3239,6 +3250,7 @@ public CompletableFuture<WatchResponse> pushAsync(
       .setMethod("POST")
       .setBody(pushTaskPayload)
       .addQueryParameter("watch", watch)
+      .addQueryParameter("referenceIndexName", referenceIndexName)
       .build();
     return executeAsync(
       request,
@@ -3265,11 +3277,18 @@ public CompletableFuture<WatchResponse> pushAsync(
    * @param pushTaskPayload (required)
    * @param watch When provided, the push operation will be synchronous and the API will wait for
    *     the ingestion to be finished before responding. (optional)
+   * @param referenceIndexName This is required when targeting an index that does not have a push
+   *     connector setup (e.g. a tmp index), but you wish to attach another index's transformation
+   *     to it (e.g. the source index name). (optional)
    * @throws AlgoliaRuntimeException If it fails to process the API call
    */
-  public CompletableFuture<WatchResponse> pushAsync(@Nonnull String indexName, @Nonnull PushTaskPayload pushTaskPayload, Boolean watch)
-    throws AlgoliaRuntimeException {
-    return this.pushAsync(indexName, pushTaskPayload, watch, null);
+  public CompletableFuture<WatchResponse> pushAsync(
+    @Nonnull String indexName,
+    @Nonnull PushTaskPayload pushTaskPayload,
+    Boolean watch,
+    String referenceIndexName
+  ) throws AlgoliaRuntimeException {
+    return this.pushAsync(indexName, pushTaskPayload, watch, referenceIndexName, null);
   }
 
   /**
@@ -3293,7 +3312,7 @@ public CompletableFuture<WatchResponse> pushAsync(
     @Nonnull PushTaskPayload pushTaskPayload,
     @Nullable RequestOptions requestOptions
   ) throws AlgoliaRuntimeException {
-    return this.pushAsync(indexName, pushTaskPayload, null, requestOptions);
+    return this.pushAsync(indexName, pushTaskPayload, null, null, requestOptions);
   }
 
   /**
@@ -3312,7 +3331,7 @@ public CompletableFuture<WatchResponse> pushAsync(
    */
   public CompletableFuture<WatchResponse> pushAsync(@Nonnull String indexName, @Nonnull PushTaskPayload pushTaskPayload)
     throws AlgoliaRuntimeException {
-    return this.pushAsync(indexName, pushTaskPayload, null, null);
+    return this.pushAsync(indexName, pushTaskPayload, null, null, null);
   }
 
   /**

clients/algoliasearch-client-java/algoliasearch/src/main/java/com/algolia/api/IngestionClient.java

@@ -6838,6 +6838,7 @@ public <T> WatchResponse saveObjectsWithTransformation(
         indexName,
         new PushTaskPayload().setAction(com.algolia.model.ingestion.Action.ADD_OBJECT).setRecords(this.objectsToPushTaskRecords(objects)),
         waitForTasks,
+        null,
         requestOptions
       );
   }
@@ -7095,6 +7096,7 @@ public <T> WatchResponse partialUpdateObjectsWithTransformation(
           )
           .setRecords(this.objectsToPushTaskRecords(objects)),
         waitForTasks,
+        null,
         requestOptions
       );
   }

clients/algoliasearch-client-java/algoliasearch/src/main/java/com/algolia/api/SearchClient.java

@@ -593,6 +593,10 @@ export type PushProps = {
    * When provided, the push operation will be synchronous and the API will wait for the ingestion to be finished before responding.
    */
   watch?: boolean | undefined;
+  /**
+   * This is required when targeting an index that does not have a push connector setup (e.g. a tmp index), but you wish to attach another index\'s transformation to it (e.g. the source index name).
+   */
+  referenceIndexName?: string | undefined;
 };
 
 /**

clients/algoliasearch-client-javascript/packages/ingestion/model/clientMethodProps.ts

@@ -1714,9 +1714,13 @@ export function createIngestionClient({
      * @param push.indexName - Name of the index on which to perform the operation.
      * @param push.pushTaskPayload - The pushTaskPayload object.
      * @param push.watch - When provided, the push operation will be synchronous and the API will wait for the ingestion to be finished before responding.
+     * @param push.referenceIndexName - This is required when targeting an index that does not have a push connector setup (e.g. a tmp index), but you wish to attach another index\'s transformation to it (e.g. the source index name).
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    push({ indexName, pushTaskPayload, watch }: PushProps, requestOptions?: RequestOptions): Promise<WatchResponse> {
+    push(
+      { indexName, pushTaskPayload, watch, referenceIndexName }: PushProps,
+      requestOptions?: RequestOptions,
+    ): Promise<WatchResponse> {
       if (!indexName) {
         throw new Error('Parameter `indexName` is required when calling `push`.');
       }
@@ -1740,6 +1744,10 @@ export function createIngestionClient({
         queryParameters['watch'] = watch.toString();
       }
 
+      if (referenceIndexName !== undefined) {
+        queryParameters['referenceIndexName'] = referenceIndexName.toString();
+      }
+
       const request: Request = {
         method: 'POST',
         path: requestPath,

clients/algoliasearch-client-javascript/packages/ingestion/src/ingestionClient.ts

@@ -931,15 +931,17 @@ public class IngestionClient(
    * @param indexName Name of the index on which to perform the operation.
    * @param pushTaskPayload
    * @param watch When provided, the push operation will be synchronous and the API will wait for the ingestion to be finished before responding.
+   * @param referenceIndexName This is required when targeting an index that does not have a push connector setup (e.g. a tmp index), but you wish to attach another index's transformation to it (e.g. the source index name).
    * @param requestOptions additional request configuration.
    */
-  public suspend fun push(indexName: String, pushTaskPayload: PushTaskPayload, watch: Boolean? = null, requestOptions: RequestOptions? = null): WatchResponse {
+  public suspend fun push(indexName: String, pushTaskPayload: PushTaskPayload, watch: Boolean? = null, referenceIndexName: String? = null, requestOptions: RequestOptions? = null): WatchResponse {
     require(indexName.isNotBlank()) { "Parameter `indexName` is required when calling `push`." }
     val requestConfig = RequestConfig(
       method = RequestMethod.POST,
       path = listOf("1", "push", "$indexName"),
       query = buildMap {
         watch?.let { put("watch", it) }
+        referenceIndexName?.let { put("referenceIndexName", it) }
       },
       body = pushTaskPayload,
     )

clients/algoliasearch-client-kotlin/client/src/commonMain/kotlin/com/algolia/client/api/IngestionClient.kt

@@ -1814,12 +1814,13 @@ public function listTransformations($itemsPerPage = null, $page = null, $sort =
      *
      * @see PushTaskPayload
      *
-     * @param bool  $watch          When provided, the push operation will be synchronous and the API will wait for the ingestion to be finished before responding. (optional)
-     * @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
+     * @param bool   $watch              When provided, the push operation will be synchronous and the API will wait for the ingestion to be finished before responding. (optional)
+     * @param string $referenceIndexName This is required when targeting an index that does not have a push connector setup (e.g. a tmp index), but you wish to attach another index's transformation to it (e.g. the source index name). (optional)
+     * @param array  $requestOptions     the requestOptions to send along with the query, they will be merged with the transporter requestOptions
      *
      * @return array<string, mixed>|WatchResponse
      */
-    public function push($indexName, $pushTaskPayload, $watch = null, $requestOptions = [])
+    public function push($indexName, $pushTaskPayload, $watch = null, $referenceIndexName = null, $requestOptions = [])
     {
         // verify the required parameter 'indexName' is set
         if (!isset($indexName)) {
@@ -1843,6 +1844,10 @@ public function push($indexName, $pushTaskPayload, $watch = null, $requestOption
             $queryParameters['watch'] = $watch;
         }
 
+        if (null !== $referenceIndexName) {
+            $queryParameters['referenceIndexName'] = $referenceIndexName;
+        }
+
         // path params
         if (null !== $indexName) {
             $resourcePath = str_replace(