feat(specs): add put task endpoint to ingestion api (generated)

algolia/api-clients-automation#5281

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

Author: algolia-bot

packages/ingestion/model/clientMethodProps.ts

@@ -30,6 +30,8 @@ import type { SourceSortKeys } from '../model/sourceSortKeys';
 import type { SourceType } from '../model/sourceType';
 import type { SourceUpdate } from '../model/sourceUpdate';
 
+import type { TaskReplace } from '../model/taskReplace';
+
 import type { TaskSortKeys } from '../model/taskSortKeys';
 import type { TaskUpdate } from '../model/taskUpdate';
 
@@ -616,6 +618,17 @@ export type PushTaskProps = {
   watch?: boolean | undefined;
 };
 
+/**
+ * Properties for the `replaceTask` method.
+ */
+export type ReplaceTaskProps = {
+  /**
+   * Unique identifier of a task.
+   */
+  taskID: string;
+  taskReplace: TaskReplace;
+};
+
 /**
  * Properties for the `runSource` method.
  */

packages/ingestion/model/index.ts

@@ -126,6 +126,7 @@ export * from './taskCreateResponse';
 export * from './taskCreateTrigger';
 export * from './taskCreateV1';
 export * from './taskInput';
+export * from './taskReplace';
 export * from './taskSearch';
 export * from './taskSortKeys';
 export * from './taskUpdate';

packages/ingestion/model/taskReplace.ts

@@ -0,0 +1,46 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+import type { ActionType } from './actionType';
+import type { Notifications } from './notifications';
+import type { Policies } from './policies';
+import type { TaskInput } from './taskInput';
+
+/**
+ * API request body for updating a task.
+ */
+export type TaskReplace = {
+  /**
+   * Universally unique identifier (UUID) of a destination resource.
+   */
+  destinationID: string;
+
+  action: ActionType;
+
+  subscriptionAction?: ActionType | undefined;
+
+  /**
+   * Cron expression for the task\'s schedule.
+   */
+  cron?: string | undefined;
+
+  /**
+   * Whether the task is enabled.
+   */
+  enabled?: boolean | undefined;
+
+  /**
+   * Maximum accepted percentage of failures for a task run to finish successfully.
+   */
+  failureThreshold?: number | undefined;
+
+  input?: TaskInput | undefined;
+
+  /**
+   * Date of the last cursor in RFC 3339 format.
+   */
+  cursor?: string | undefined;
+
+  notifications?: Notifications | undefined;
+
+  policies?: Policies | undefined;
+};

packages/ingestion/model/taskUpdate.ts

@@ -6,7 +6,7 @@ import type { Policies } from './policies';
 import type { TaskInput } from './taskInput';
 
 /**
- * API request body for updating a task.
+ * API request body for partially updating a task.
  */
 export type TaskUpdate = {
   /**

packages/ingestion/src/ingestionClient.ts

@@ -51,6 +51,7 @@ import type { Task } from '../model/task';
 import type { TaskCreate } from '../model/taskCreate';
 import type { TaskCreateResponse } from '../model/taskCreateResponse';
 import type { TaskCreateV1 } from '../model/taskCreateV1';
+
 import type { TaskSearch } from '../model/taskSearch';
 
 import type { TaskUpdateResponse } from '../model/taskUpdateResponse';
@@ -101,6 +102,7 @@ import type {
   ListTransformationsProps,
   PushProps,
   PushTaskProps,
+  ReplaceTaskProps,
   RunSourceProps,
   RunTaskProps,
   RunTaskV1Props,
@@ -1911,6 +1913,47 @@ export function createIngestionClient({
       return transporter.request(request, requestOptions);
     },
 
+    /**
+     * Fully updates a task by its ID, use partialUpdateTask if you only want to update a subset of fields.
+     * @param replaceTask - The replaceTask object.
+     * @param replaceTask.taskID - Unique identifier of a task.
+     * @param replaceTask.taskReplace - The taskReplace object.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    replaceTask(
+      { taskID, taskReplace }: ReplaceTaskProps,
+      requestOptions?: RequestOptions,
+    ): Promise<TaskUpdateResponse> {
+      if (!taskID) {
+        throw new Error('Parameter `taskID` is required when calling `replaceTask`.');
+      }
+
+      if (!taskReplace) {
+        throw new Error('Parameter `taskReplace` is required when calling `replaceTask`.');
+      }
+
+      if (!taskReplace.destinationID) {
+        throw new Error('Parameter `taskReplace.destinationID` is required when calling `replaceTask`.');
+      }
+      if (!taskReplace.action) {
+        throw new Error('Parameter `taskReplace.action` is required when calling `replaceTask`.');
+      }
+
+      const requestPath = '/2/tasks/{taskID}'.replace('{taskID}', encodeURIComponent(taskID));
+      const headers: Headers = {};
+      const queryParameters: QueryParameters = {};
+
+      const request: Request = {
+        method: 'PUT',
+        path: requestPath,
+        queryParameters,
+        headers,
+        data: taskReplace,
+      };
+
+      return transporter.request(request, requestOptions);
+    },
+
     /**
      * Runs all tasks linked to a source, only available for Shopify, BigCommerce and commercetools sources. Creates one run per task.
      *
@@ -2482,7 +2525,7 @@ export function createIngestionClient({
     },
 
     /**
-     * Updates a task by its ID.
+     * Partially updates a task by its ID.
      * @param updateTask - The updateTask object.
      * @param updateTask.taskID - Unique identifier of a task.
      * @param updateTask.taskUpdate - The taskUpdate object.