@algolia/ingestion 1.0.0-beta.11 → 1.0.0-beta.12

package/model/clientMethodProps.ts

@@ -4,6 +4,7 @@ import type { ActionType } from './actionType';
 import type { AuthenticationSortKeys } from './authenticationSortKeys';
 import type { AuthenticationType } from './authenticationType';
 import type { AuthenticationUpdate } from './authenticationUpdate';
+import type { BatchWriteParams } from './batchWriteParams';
 import type { DestinationSortKeys } from './destinationSortKeys';
 import type { DestinationType } from './destinationType';
 import type { DestinationUpdate } from './destinationUpdate';
@@ -20,6 +21,7 @@ import type { SourceType } from './sourceType';
 import type { SourceUpdate } from './sourceUpdate';
 import type { TaskSortKeys } from './taskSortKeys';
 import type { TaskUpdate } from './taskUpdate';
+import type { TaskUpdateV1 } from './taskUpdateV1';
 import type { TransformationCreate } from './transformationCreate';
 import type { TriggerType } from './triggerType';
 
@@ -127,6 +129,16 @@ export type DeleteTaskProps = {
   taskID: string;
 };
 
+/**
+ * Properties for the `deleteTaskV1` method.
+ */
+export type DeleteTaskV1Props = {
+  /**
+   * Unique identifier of a task.
+   */
+  taskID: string;
+};
+
 /**
  * Properties for the `deleteTransformation` method.
  */
@@ -147,6 +159,16 @@ export type DisableTaskProps = {
   taskID: string;
 };
 
+/**
+ * Properties for the `disableTaskV1` method.
+ */
+export type DisableTaskV1Props = {
+  /**
+   * Unique identifier of a task.
+   */
+  taskID: string;
+};
+
 /**
  * Properties for the `enableTask` method.
  */
@@ -157,6 +179,16 @@ export type EnableTaskProps = {
   taskID: string;
 };
 
+/**
+ * Properties for the `enableTaskV1` method.
+ */
+export type EnableTaskV1Props = {
+  /**
+   * Unique identifier of a task.
+   */
+  taskID: string;
+};
+
 /**
  * Properties for the `getAuthentication` method.
  */
@@ -168,9 +200,83 @@ export type GetAuthenticationProps = {
 };
 
 /**
- * Properties for the `getAuthentications` method.
+ * Properties for the `getDestination` method.
  */
-export type GetAuthenticationsProps = {
+export type GetDestinationProps = {
+  /**
+   * Unique identifier of a destination.
+   */
+  destinationID: string;
+};
+
+/**
+ * Properties for the `getEvent` method.
+ */
+export type GetEventProps = {
+  /**
+   * Unique identifier of a task run.
+   */
+  runID: string;
+  /**
+   * Unique identifier of an event.
+   */
+  eventID: string;
+};
+
+/**
+ * Properties for the `getRun` method.
+ */
+export type GetRunProps = {
+  /**
+   * Unique identifier of a task run.
+   */
+  runID: string;
+};
+
+/**
+ * Properties for the `getSource` method.
+ */
+export type GetSourceProps = {
+  /**
+   * Unique identifier of a source.
+   */
+  sourceID: string;
+};
+
+/**
+ * Properties for the `getTask` method.
+ */
+export type GetTaskProps = {
+  /**
+   * Unique identifier of a task.
+   */
+  taskID: string;
+};
+
+/**
+ * Properties for the `getTaskV1` method.
+ */
+export type GetTaskV1Props = {
+  /**
+   * Unique identifier of a task.
+   */
+  taskID: string;
+};
+
+/**
+ * Properties for the `getTransformation` method.
+ */
+export type GetTransformationProps = {
+  /**
+   * Unique identifier of a transformation.
+   */
+  transformationID: string;
+};
+
+/**
+ * Properties for the `listAuthentications` method.
+ */
+export type ListAuthenticationsProps = {
   /**
    * Number of items per page.
    */
@@ -198,19 +304,9 @@ export type GetAuthenticationsProps = {
 };
 
 /**
- * Properties for the `getDestination` method.
- */
-export type GetDestinationProps = {
-  /**
-   * Unique identifier of a destination.
-   */
-  destinationID: string;
-};
-
-/**
- * Properties for the `getDestinations` method.
+ * Properties for the `listDestinations` method.
  */
-export type GetDestinationsProps = {
+export type ListDestinationsProps = {
   /**
    * Number of items per page.
    */
@@ -238,23 +334,9 @@ export type GetDestinationsProps = {
 };
 
 /**
- * Properties for the `getEvent` method.
+ * Properties for the `listEvents` method.
  */
-export type GetEventProps = {
-  /**
-   * Unique identifier of a task run.
-   */
-  runID: string;
-  /**
-   * Unique identifier of an event.
-   */
-  eventID: string;
-};
-
-/**
- * Properties for the `getEvents` method.
- */
-export type GetEventsProps = {
+export type ListEventsProps = {
   /**
    * Unique identifier of a task run.
    */
@@ -294,19 +376,9 @@ export type GetEventsProps = {
 };
 
 /**
- * Properties for the `getRun` method.
+ * Properties for the `listRuns` method.
  */
-export type GetRunProps = {
-  /**
-   * Unique identifier of a task run.
-   */
-  runID: string;
-};
-
-/**
- * Properties for the `getRuns` method.
- */
-export type GetRunsProps = {
+export type ListRunsProps = {
   /**
    * Number of items per page.
    */
@@ -342,19 +414,9 @@ export type GetRunsProps = {
 };
 
 /**
- * Properties for the `getSource` method.
+ * Properties for the `listSources` method.
  */
-export type GetSourceProps = {
-  /**
-   * Unique identifier of a source.
-   */
-  sourceID: string;
-};
-
-/**
- * Properties for the `getSources` method.
- */
-export type GetSourcesProps = {
+export type ListSourcesProps = {
   /**
    * Number of items per page.
    */
@@ -382,19 +444,51 @@ export type GetSourcesProps = {
 };
 
 /**
- * Properties for the `getTask` method.
+ * Properties for the `listTasks` method.
  */
-export type GetTaskProps = {
+export type ListTasksProps = {
   /**
-   * Unique identifier of a task.
+   * Number of items per page.
    */
-  taskID: string;
+  itemsPerPage?: number;
+  /**
+   * Page number of the paginated API response.
+   */
+  page?: number;
+  /**
+   * Actions for filtering the list of tasks.
+   */
+  action?: ActionType[];
+  /**
+   * Whether to filter the list of tasks by the `enabled` status.
+   */
+  enabled?: boolean;
+  /**
+   * Source IDs for filtering the list of tasks.
+   */
+  sourceID?: string[];
+  /**
+   * Destination IDs for filtering the list of tasks.
+   */
+  destinationID?: string[];
+  /**
+   * Type of task trigger for filtering the list of tasks.
+   */
+  triggerType?: TriggerType[];
+  /**
+   * Property by which to sort the list of tasks.
+   */
+  sort?: TaskSortKeys;
+  /**
+   * Sort order of the response, ascending or descending.
+   */
+  order?: OrderKeys;
 };
 
 /**
- * Properties for the `getTasks` method.
+ * Properties for the `listTasksV1` method.
  */
-export type GetTasksProps = {
+export type ListTasksV1Props = {
   /**
    * Number of items per page.
    */
@@ -434,27 +528,31 @@ export type GetTasksProps = {
 };
 
 /**
- * Properties for the `getTransformation` method.
+ * Properties for the `listTransformations` method.
  */
-export type GetTransformationProps = {
+export type ListTransformationsProps = {
   /**
-   * Unique identifier of a transformation.
+   * Property by which to sort the list.
    */
-  transformationID: string;
+  sort?: SortKeys;
+  /**
+   * Sort order of the response, ascending or descending.
+   */
+  order?: OrderKeys;
 };
 
 /**
- * Properties for the `getTransformations` method.
+ * Properties for the `pushTask` method.
  */
-export type GetTransformationsProps = {
+export type PushTaskProps = {
   /**
-   * Property by which to sort the list.
+   * Unique identifier of a task.
    */
-  sort?: SortKeys;
+  taskID: string;
   /**
-   * Sort order of the response, ascending or descending.
+   * Request body of a Search API `batch` request that will be pushed in the Connectors pipeline.
    */
-  order?: OrderKeys;
+  batchWriteParams: BatchWriteParams;
 };
 
 /**
@@ -467,6 +565,16 @@ export type RunTaskProps = {
   taskID: string;
 };
 
+/**
+ * Properties for the `runTaskV1` method.
+ */
+export type RunTaskV1Props = {
+  /**
+   * Unique identifier of a task.
+   */
+  taskID: string;
+};
+
 /**
  * Properties for the `triggerDockerSourceDiscover` method.
  */
@@ -521,6 +629,17 @@ export type UpdateTaskProps = {
   taskUpdate: TaskUpdate;
 };
 
+/**
+ * Properties for the `updateTaskV1` method.
+ */
+export type UpdateTaskV1Props = {
+  /**
+   * Unique identifier of a task.
+   */
+  taskID: string;
+  taskUpdate: TaskUpdateV1;
+};
+
 /**
  * Properties for the `updateTransformation` method.
  */

package/model/index.ts

@@ -1,5 +1,6 @@
 // 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.
 
+export * from './action';
 export * from './actionType';
 export * from './authAPIKey';
 export * from './authAPIKeyPartial';
@@ -23,6 +24,8 @@ export * from './authenticationSortKeys';
 export * from './authenticationType';
 export * from './authenticationUpdate';
 export * from './authenticationUpdateResponse';
+export * from './batchRequest';
+export * from './batchWriteParams';
 export * from './bigCommerceChannel';
 export * from './bigCommerceMetafield';
 export * from './bigQueryDataType';
@@ -52,6 +55,7 @@ export * from './listDestinationsResponse';
 export * from './listEventsResponse';
 export * from './listSourcesResponse';
 export * from './listTasksResponse';
+export * from './listTasksResponseV1';
 export * from './listTransformationsResponse';
 export * from './mappingFieldDirective';
 export * from './mappingFormatSchema';
@@ -116,11 +120,14 @@ export * from './task';
 export * from './taskCreate';
 export * from './taskCreateResponse';
 export * from './taskCreateTrigger';
+export * from './taskCreateV1';
 export * from './taskInput';
 export * from './taskSearch';
 export * from './taskSortKeys';
 export * from './taskUpdate';
 export * from './taskUpdateResponse';
+export * from './taskUpdateV1';
+export * from './taskV1';
 export * from './transformation';
 export * from './transformationCreate';
 export * from './transformationCreateResponse';

package/model/listTasksResponseV1.ts

@@ -0,0 +1,13 @@
+// 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 { Pagination } from './pagination';
+import type { TaskV1 } from './taskV1';
+
+/**
+ * Configured tasks and pagination information.
+ */
+export type ListTasksResponseV1 = {
+  tasks: TaskV1[];
+
+  pagination: Pagination;
+};

package/model/task.ts

@@ -2,7 +2,6 @@
 
 import type { ActionType } from './actionType';
 import type { TaskInput } from './taskInput';
-import type { Trigger } from './trigger';
 
 export type Task = {
   /**
@@ -20,7 +19,20 @@ export type Task = {
    */
   destinationID: string;
 
-  trigger: Trigger;
+  /**
+   * Cron expression for the task\'s schedule.
+   */
+  cron?: string;
+
+  /**
+   * The last time the scheduled task ran in RFC 3339 format.
+   */
+  lastRun?: string;
+
+  /**
+   * The next scheduled run of the task in RFC 3339 format.
+   */
+  nextRun?: string;
 
   input?: TaskInput;
 

package/model/taskCreate.ts

@@ -1,7 +1,6 @@
 // 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 { TaskCreateTrigger } from './taskCreateTrigger';
 import type { TaskInput } from './taskInput';
 
 /**
@@ -18,10 +17,13 @@ export type TaskCreate = {
    */
   destinationID: string;
 
-  trigger: TaskCreateTrigger;
-
   action: ActionType;
 
+  /**
+   * Cron expression for the task\'s schedule.
+   */
+  cron?: string;
+
   /**
    * Whether the task is enabled.
    */

package/model/taskCreateV1.ts

@@ -0,0 +1,41 @@
+// 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 { TaskCreateTrigger } from './taskCreateTrigger';
+import type { TaskInput } from './taskInput';
+
+/**
+ * API request body for creating a task using the V1 shape, please use methods and types that don\'t contain the V1 suffix.
+ */
+export type TaskCreateV1 = {
+  /**
+   * Universally uniqud identifier (UUID) of a source.
+   */
+  sourceID: string;
+
+  /**
+   * Universally unique identifier (UUID) of a destination resource.
+   */
+  destinationID: string;
+
+  trigger: TaskCreateTrigger;
+
+  action: ActionType;
+
+  /**
+   * Whether the task is enabled.
+   */
+  enabled?: boolean;
+
+  /**
+   * Maximum accepted percentage of failures for a task run to finish successfully.
+   */
+  failureThreshold?: number;
+
+  input?: TaskInput;
+
+  /**
+   * Date of the last cursor in RFC 3339 format.
+   */
+  cursor?: string;
+};

package/model/taskUpdate.ts

@@ -1,7 +1,6 @@
 // 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 { TaskInput } from './taskInput';
-import type { TriggerUpdateInput } from './triggerUpdateInput';
 
 /**
  * API request body for updating a task.
@@ -12,7 +11,10 @@ export type TaskUpdate = {
    */
   destinationID?: string;
 
-  trigger?: TriggerUpdateInput;
+  /**
+   * Cron expression for the task\'s schedule.
+   */
+  cron?: string;
 
   input?: TaskInput;
 

package/model/taskUpdateV1.ts

@@ -0,0 +1,28 @@
+// 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 { TaskInput } from './taskInput';
+import type { TriggerUpdateInput } from './triggerUpdateInput';
+
+/**
+ * API request body for updating a task using the V1 shape, please use methods and types that don\'t contain the V1 suffix.
+ */
+export type TaskUpdateV1 = {
+  /**
+   * Universally unique identifier (UUID) of a destination resource.
+   */
+  destinationID?: string;
+
+  trigger?: TriggerUpdateInput;
+
+  input?: TaskInput;
+
+  /**
+   * Whether the task is enabled.
+   */
+  enabled?: boolean;
+
+  /**
+   * Maximum accepted percentage of failures for a task run to finish successfully.
+   */
+  failureThreshold?: number;
+};

package/model/taskV1.ts

@@ -0,0 +1,56 @@
+// 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 { TaskInput } from './taskInput';
+import type { Trigger } from './trigger';
+
+/**
+ * The V1 task object, please use methods and types that don\'t contain the V1 suffix.
+ */
+export type TaskV1 = {
+  /**
+   * Universally unique identifier (UUID) of a task.
+   */
+  taskID: string;
+
+  /**
+   * Universally uniqud identifier (UUID) of a source.
+   */
+  sourceID: string;
+
+  /**
+   * Universally unique identifier (UUID) of a destination resource.
+   */
+  destinationID: string;
+
+  trigger: Trigger;
+
+  input?: TaskInput;
+
+  /**
+   * Whether the task is enabled.
+   */
+  enabled: boolean;
+
+  /**
+   * Maximum accepted percentage of failures for a task run to finish successfully.
+   */
+  failureThreshold?: number;
+
+  action: ActionType;
+
+  /**
+   * Date of the last cursor in RFC 3339 format.
+   */
+  cursor?: string;
+
+  /**
+   * Date of creation in RFC 3339 format.
+   */
+  createdAt: string;
+
+  /**
+   * Date of last update in RFC 3339 format.
+   */
+  updatedAt?: string;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@algolia/ingestion",
-  "version": "1.0.0-beta.11",
+  "version": "1.0.0-beta.12",
   "description": "JavaScript client for ingestion",
   "repository": {
     "type": "git",
@@ -42,12 +42,12 @@
     "clean": "rm -rf ./dist || true"
   },
   "dependencies": {
-    "@algolia/client-common": "5.0.0-beta.12",
-    "@algolia/requester-browser-xhr": "5.0.0-beta.12",
-    "@algolia/requester-node-http": "5.0.0-beta.12"
+    "@algolia/client-common": "5.0.0-beta.13",
+    "@algolia/requester-browser-xhr": "5.0.0-beta.13",
+    "@algolia/requester-node-http": "5.0.0-beta.13"
   },
   "devDependencies": {
-    "@types/node": "20.14.10",
+    "@types/node": "20.14.11",
     "rollup": "4.18.1",
     "typescript": "5.5.3"
   },