feat(specs): allow filtering transformations type (#5363) (generated) [skip ci]

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

Author: algolia-bot

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

@@ -1642,6 +1642,7 @@ ListTasksResponseV1 ListTasksV1(
   /// <param name="page">Page number of the paginated API response. (optional)</param>
   /// <param name="sort">Property by which to sort the list of transformations. (optional)</param>
   /// <param name="order">Sort order of the response, ascending or descending. (optional)</param>
+  /// <param name="type">Whether to filter the list of transformations by the type of transformation. (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>
@@ -1653,6 +1654,7 @@ Task<ListTransformationsResponse> ListTransformationsAsync(
     int? page = default,
     TransformationSortKeys? sort = default,
     OrderKeys? order = default,
+    TransformationType? type = default,
     RequestOptions options = null,
     CancellationToken cancellationToken = default
   );
@@ -1669,6 +1671,7 @@ Task<ListTransformationsResponse> ListTransformationsAsync(
   /// <param name="page">Page number of the paginated API response. (optional)</param>
   /// <param name="sort">Property by which to sort the list of transformations. (optional)</param>
   /// <param name="order">Sort order of the response, ascending or descending. (optional)</param>
+  /// <param name="type">Whether to filter the list of transformations by the type of transformation. (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>
@@ -1680,6 +1683,7 @@ ListTransformationsResponse ListTransformations(
     int? page = default,
     TransformationSortKeys? sort = default,
     OrderKeys? order = default,
+    TransformationType? type = default,
     RequestOptions options = null,
     CancellationToken cancellationToken = default
   );
@@ -4171,6 +4175,7 @@ public async Task<ListTransformationsResponse> ListTransformationsAsync(
     int? page = default,
     TransformationSortKeys? sort = default,
     OrderKeys? order = default,
+    TransformationType? type = default,
     RequestOptions options = null,
     CancellationToken cancellationToken = default
   )
@@ -4181,6 +4186,7 @@ public async Task<ListTransformationsResponse> ListTransformationsAsync(
     requestOptions.AddQueryParameter("page", page);
     requestOptions.AddQueryParameter("sort", sort);
     requestOptions.AddQueryParameter("order", order);
+    requestOptions.AddQueryParameter("type", type);
     return await _transport
       .ExecuteRequestAsync<ListTransformationsResponse>(
         new HttpMethod("GET"),
@@ -4197,11 +4203,12 @@ public ListTransformationsResponse ListTransformations(
     int? page = default,
     TransformationSortKeys? sort = default,
     OrderKeys? order = default,
+    TransformationType? type = default,
     RequestOptions options = null,
     CancellationToken cancellationToken = default
   ) =>
     AsyncHelper.RunSync(() =>
-      ListTransformationsAsync(itemsPerPage, page, sort, order, options, cancellationToken)
+      ListTransformationsAsync(itemsPerPage, page, sort, order, type, options, cancellationToken)
     );
 
   /// <inheritdoc />

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

@@ -2998,6 +2998,8 @@ public CompletableFuture<ListTasksResponseV1> listTasksV1Async() throws AlgoliaR
    * @param sort Property by which to sort the list of transformations. (optional, default to
    *     createdAt)
    * @param order Sort order of the response, ascending or descending. (optional, default to desc)
+   * @param type Whether to filter the list of transformations by the type of transformation.
+   *     (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
@@ -3007,9 +3009,10 @@ public ListTransformationsResponse listTransformations(
     Integer page,
     TransformationSortKeys sort,
     OrderKeys order,
+    TransformationType type,
     @Nullable RequestOptions requestOptions
   ) throws AlgoliaRuntimeException {
-    return LaunderThrowable.await(listTransformationsAsync(itemsPerPage, page, sort, order, requestOptions));
+    return LaunderThrowable.await(listTransformationsAsync(itemsPerPage, page, sort, order, type, requestOptions));
   }
 
   /**
@@ -3020,11 +3023,18 @@ public ListTransformationsResponse listTransformations(
    * @param sort Property by which to sort the list of transformations. (optional, default to
    *     createdAt)
    * @param order Sort order of the response, ascending or descending. (optional, default to desc)
+   * @param type Whether to filter the list of transformations by the type of transformation.
+   *     (optional)
    * @throws AlgoliaRuntimeException If it fails to process the API call
    */
-  public ListTransformationsResponse listTransformations(Integer itemsPerPage, Integer page, TransformationSortKeys sort, OrderKeys order)
-    throws AlgoliaRuntimeException {
-    return this.listTransformations(itemsPerPage, page, sort, order, null);
+  public ListTransformationsResponse listTransformations(
+    Integer itemsPerPage,
+    Integer page,
+    TransformationSortKeys sort,
+    OrderKeys order,
+    TransformationType type
+  ) throws AlgoliaRuntimeException {
+    return this.listTransformations(itemsPerPage, page, sort, order, type, null);
   }
 
   /**
@@ -3035,7 +3045,7 @@ public ListTransformationsResponse listTransformations(Integer itemsPerPage, Int
    * @throws AlgoliaRuntimeException If it fails to process the API call
    */
   public ListTransformationsResponse listTransformations(@Nullable RequestOptions requestOptions) throws AlgoliaRuntimeException {
-    return this.listTransformations(null, null, null, null, requestOptions);
+    return this.listTransformations(null, null, null, null, null, requestOptions);
   }
 
   /**
@@ -3044,7 +3054,7 @@ public ListTransformationsResponse listTransformations(@Nullable RequestOptions
    * @throws AlgoliaRuntimeException If it fails to process the API call
    */
   public ListTransformationsResponse listTransformations() throws AlgoliaRuntimeException {
-    return this.listTransformations(null, null, null, null, null);
+    return this.listTransformations(null, null, null, null, null, null);
   }
 
   /**
@@ -3055,6 +3065,8 @@ public ListTransformationsResponse listTransformations() throws AlgoliaRuntimeEx
    * @param sort Property by which to sort the list of transformations. (optional, default to
    *     createdAt)
    * @param order Sort order of the response, ascending or descending. (optional, default to desc)
+   * @param type Whether to filter the list of transformations by the type of transformation.
+   *     (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
@@ -3064,6 +3076,7 @@ public CompletableFuture<ListTransformationsResponse> listTransformationsAsync(
     Integer page,
     TransformationSortKeys sort,
     OrderKeys order,
+    TransformationType type,
     @Nullable RequestOptions requestOptions
   ) throws AlgoliaRuntimeException {
     HttpRequest request = HttpRequest.builder()
@@ -3073,6 +3086,7 @@ public CompletableFuture<ListTransformationsResponse> listTransformationsAsync(
       .addQueryParameter("page", page)
       .addQueryParameter("sort", sort)
       .addQueryParameter("order", order)
+      .addQueryParameter("type", type)
       .build();
     return executeAsync(request, requestOptions, new TypeReference<ListTransformationsResponse>() {});
   }
@@ -3085,15 +3099,18 @@ public CompletableFuture<ListTransformationsResponse> listTransformationsAsync(
    * @param sort Property by which to sort the list of transformations. (optional, default to
    *     createdAt)
    * @param order Sort order of the response, ascending or descending. (optional, default to desc)
+   * @param type Whether to filter the list of transformations by the type of transformation.
+   *     (optional)
    * @throws AlgoliaRuntimeException If it fails to process the API call
    */
   public CompletableFuture<ListTransformationsResponse> listTransformationsAsync(
     Integer itemsPerPage,
     Integer page,
     TransformationSortKeys sort,
-    OrderKeys order
+    OrderKeys order,
+    TransformationType type
   ) throws AlgoliaRuntimeException {
-    return this.listTransformationsAsync(itemsPerPage, page, sort, order, null);
+    return this.listTransformationsAsync(itemsPerPage, page, sort, order, type, null);
   }
 
   /**
@@ -3105,7 +3122,7 @@ public CompletableFuture<ListTransformationsResponse> listTransformationsAsync(
    */
   public CompletableFuture<ListTransformationsResponse> listTransformationsAsync(@Nullable RequestOptions requestOptions)
     throws AlgoliaRuntimeException {
-    return this.listTransformationsAsync(null, null, null, null, requestOptions);
+    return this.listTransformationsAsync(null, null, null, null, null, requestOptions);
   }
 
   /**
@@ -3114,7 +3131,7 @@ public CompletableFuture<ListTransformationsResponse> listTransformationsAsync(@
    * @throws AlgoliaRuntimeException If it fails to process the API call
    */
   public CompletableFuture<ListTransformationsResponse> listTransformationsAsync() throws AlgoliaRuntimeException {
-    return this.listTransformationsAsync(null, null, null, null, null);
+    return this.listTransformationsAsync(null, null, null, null, null, null);
   }
 
   /**

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

@@ -42,6 +42,8 @@ import type { TransformationCreate } from '../model/transformationCreate';
 import type { TransformationSortKeys } from '../model/transformationSortKeys';
 import type { TransformationTry } from '../model/transformationTry';
 
+import type { TransformationType } from '../model/transformationType';
+
 import type { TriggerType } from '../model/triggerType';
 
 /**
@@ -582,6 +584,10 @@ export type ListTransformationsProps = {
    * Sort order of the response, ascending or descending.
    */
   order?: OrderKeys | undefined;
+  /**
+   * Whether to filter the list of transformations by the type of transformation.
+   */
+  type?: TransformationType | undefined;
 };
 
 /**

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

@@ -64,6 +64,7 @@ import type { TransformationSearch } from '../model/transformationSearch';
 
 import type { TransformationTry } from '../model/transformationTry';
 import type { TransformationTryResponse } from '../model/transformationTryResponse';
+
 import type { TransformationUpdateResponse } from '../model/transformationUpdateResponse';
 
 import type { WatchResponse } from '../model/watchResponse';
@@ -1752,10 +1753,11 @@ export function createIngestionClient({
      * @param listTransformations.page - Page number of the paginated API response.
      * @param listTransformations.sort - Property by which to sort the list of transformations.
      * @param listTransformations.order - Sort order of the response, ascending or descending.
+     * @param listTransformations.type - Whether to filter the list of transformations by the type of transformation.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     listTransformations(
-      { itemsPerPage, page, sort, order }: ListTransformationsProps = {},
+      { itemsPerPage, page, sort, order, type }: ListTransformationsProps = {},
       requestOptions: RequestOptions | undefined = undefined,
     ): Promise<ListTransformationsResponse> {
       const requestPath = '/1/transformations';
@@ -1778,6 +1780,10 @@ export function createIngestionClient({
         queryParameters['order'] = order.toString();
       }
 
+      if (type !== undefined) {
+        queryParameters['type'] = type.toString();
+      }
+
       const request: Request = {
         method: 'GET',
         path: requestPath,

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

@@ -902,9 +902,10 @@ public class IngestionClient(
    * @param page Page number of the paginated API response.
    * @param sort Property by which to sort the list of transformations. (default to createdAt)
    * @param order Sort order of the response, ascending or descending. (default to desc)
+   * @param type Whether to filter the list of transformations by the type of transformation.
    * @param requestOptions additional request configuration.
    */
-  public suspend fun listTransformations(itemsPerPage: Int? = null, page: Int? = null, sort: TransformationSortKeys? = null, order: OrderKeys? = null, requestOptions: RequestOptions? = null): ListTransformationsResponse {
+  public suspend fun listTransformations(itemsPerPage: Int? = null, page: Int? = null, sort: TransformationSortKeys? = null, order: OrderKeys? = null, type: TransformationType? = null, requestOptions: RequestOptions? = null): ListTransformationsResponse {
     val requestConfig = RequestConfig(
       method = RequestMethod.GET,
       path = listOf("1", "transformations"),
@@ -913,6 +914,7 @@ public class IngestionClient(
         page?.let { put("page", it) }
         sort?.let { put("sort", it) }
         order?.let { put("order", it) }
+        type?.let { put("type", it) }
       },
     )
     return requester.execute(

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

@@ -1773,11 +1773,12 @@ public function listTasksV1($itemsPerPage = null, $page = null, $action = null,
      * @param int   $page           Page number of the paginated API response. (optional)
      * @param array $sort           Property by which to sort the list of transformations. (optional)
      * @param array $order          Sort order of the response, ascending or descending. (optional)
+     * @param array $type           Whether to filter the list of transformations by the type of transformation. (optional)
      * @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
      *
      * @return array<string, mixed>|ListTransformationsResponse
      */
-    public function listTransformations($itemsPerPage = null, $page = null, $sort = null, $order = null, $requestOptions = [])
+    public function listTransformations($itemsPerPage = null, $page = null, $sort = null, $order = null, $type = null, $requestOptions = [])
     {
         $resourcePath = '/1/transformations';
         $queryParameters = [];
@@ -1800,6 +1801,10 @@ public function listTransformations($itemsPerPage = null, $page = null, $sort =
             $queryParameters['order'] = $order;
         }
 
+        if (null !== $type) {
+            $queryParameters['type'] = $type;
+        }
+
         return $this->sendRequest('GET', $resourcePath, $headers, $queryParameters, $httpBody, $requestOptions);
     }