feat(specs): add global push endpoint (generated)

algolia/api-clients-automation#4855

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

Author: algolia-bot

packages/ingestion/model/action.ts

@@ -3,11 +3,4 @@
 /**
  * Type of indexing operation.
  */
-export type Action =
-  | 'addObject'
-  | 'updateObject'
-  | 'partialUpdateObject'
-  | 'partialUpdateObjectNoCreate'
-  | 'deleteObject'
-  | 'delete'
-  | 'clear';
+export type Action = 'addObject' | 'updateObject' | 'partialUpdateObject' | 'partialUpdateObjectNoCreate';

packages/ingestion/model/clientMethodProps.ts

@@ -580,6 +580,21 @@ export type ListTransformationsProps = {
   order?: OrderKeys;
 };
 
+/**
+ * Properties for the `push` method.
+ */
+export type PushProps = {
+  /**
+   * Name of the index on which to perform the operation.
+   */
+  indexName: string;
+  pushTaskPayload: PushTaskPayload;
+  /**
+   * When provided, the push operation will be synchronous and the API will wait for the ingestion to be finished before responding.
+   */
+  watch?: boolean;
+};
+
 /**
  * Properties for the `pushTask` method.
  */
@@ -588,9 +603,6 @@ export type PushTaskProps = {
    * Unique identifier of a task.
    */
   taskID: string;
-  /**
-   * Request body of a Search API `batch` request that will be pushed in the Connectors pipeline.
-   */
   pushTaskPayload: PushTaskPayload;
   /**
    * When provided, the push operation will be synchronous and the API will wait for the ingestion to be finished before responding.

packages/ingestion/src/ingestionClient.ts

@@ -97,6 +97,7 @@ import type {
   ListTasksProps,
   ListTasksV1Props,
   ListTransformationsProps,
+  PushProps,
   PushTaskProps,
   RunSourceProps,
   RunTaskProps,
@@ -1706,15 +1707,72 @@ export function createIngestionClient({
     },
 
     /**
-     * Push a `batch` request payload through the Pipeline. You can check the status of task pushes with the observability endpoints.
+     * Pushes records through the Pipeline, directly to an index. You can make the call synchronous by providing the `watch` parameter, for asynchronous calls, you can use the observability endpoints and/or debugger dashboard to see the status of your task. If you want to leverage the [pre-indexing data transformation](https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/how-to/transform-your-data/), this is the recommended way of ingesting your records. This method is similar to `pushTask`, but requires an `indexName` instead of a `taskID`. If zero or many tasks are found, an error will be returned.
+     *
+     * Required API Key ACLs:
+     *  - addObject
+     *  - deleteIndex
+     *  - editSettings
+     * @param push - The push object.
+     * @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 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> {
+      if (!indexName) {
+        throw new Error('Parameter `indexName` is required when calling `push`.');
+      }
+
+      if (!pushTaskPayload) {
+        throw new Error('Parameter `pushTaskPayload` is required when calling `push`.');
+      }
+
+      if (!pushTaskPayload.action) {
+        throw new Error('Parameter `pushTaskPayload.action` is required when calling `push`.');
+      }
+      if (!pushTaskPayload.records) {
+        throw new Error('Parameter `pushTaskPayload.records` is required when calling `push`.');
+      }
+
+      const requestPath = '/1/push/{indexName}'.replace('{indexName}', encodeURIComponent(indexName));
+      const headers: Headers = {};
+      const queryParameters: QueryParameters = {};
+
+      if (watch !== undefined) {
+        queryParameters['watch'] = watch.toString();
+      }
+
+      const request: Request = {
+        method: 'POST',
+        path: requestPath,
+        queryParameters,
+        headers,
+        data: pushTaskPayload,
+      };
+
+      requestOptions = {
+        timeouts: {
+          connect: 180000,
+          read: 180000,
+          write: 180000,
+          ...requestOptions?.timeouts,
+        },
+      };
+
+      return transporter.request(request, requestOptions);
+    },
+
+    /**
+     * Pushes records through the Pipeline, directly to an index. You can make the call synchronous by providing the `watch` parameter, for asynchronous calls, you can use the observability endpoints and/or debugger dashboard to see the status of your task. If you want to leverage the [pre-indexing data transformation](https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/how-to/transform-your-data/), this is the recommended way of ingesting your records. This method is similar to `push`, but requires a `taskID` instead of a `indexName`, which is useful when many `destinations` target the same `indexName`.
      *
      * Required API Key ACLs:
      *  - addObject
      *  - deleteIndex
      *  - editSettings
      * @param pushTask - The pushTask object.
      * @param pushTask.taskID - Unique identifier of a task.
-     * @param pushTask.pushTaskPayload - Request body of a Search API `batch` request that will be pushed in the Connectors pipeline.
+     * @param pushTask.pushTaskPayload - The pushTaskPayload object.
      * @param pushTask.watch - When provided, the push operation will be synchronous and the API will wait for the ingestion to be finished before responding.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */