@algolia/ingestion 1.0.0-beta.9 → 1.0.0

package/model/action.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.
+
+/**
+ * Type of indexing operation.
+ */
+export type Action =
+  | 'addObject'
+  | 'clear'
+  | 'delete'
+  | 'deleteObject'
+  | 'partialUpdateObject'
+  | 'partialUpdateObjectNoCreate'
+  | 'updateObject';

package/model/batchRequest.ts

@@ -0,0 +1,12 @@
+// 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 { Action } from './action';
+
+export type BatchRequest = {
+  action: Action;
+
+  /**
+   * Operation arguments (varies with specified `action`).
+   */
+  body: Record<string, any>;
+};

package/model/{destinationIndexPrefix.ts → batchWriteParams.ts}

@@ -1,8 +1,10 @@
 // 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 type DestinationIndexPrefix = {
-  /**
-   * String added to the beginning of all indices created by this destination.
-   */
-  indexPrefix: string;
+import type { BatchRequest } from './batchRequest';
+
+/**
+ * Batch parameters.
+ */
+export type BatchWriteParams = {
+  requests: BatchRequest[];
 };

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';
@@ -13,6 +14,7 @@ import type { EventType } from './eventType';
 import type { OrderKeys } from './orderKeys';
 import type { PlatformWithNone } from './platformWithNone';
 import type { RunSortKeys } from './runSortKeys';
+import type { RunSourcePayload } from './runSourcePayload';
 import type { RunStatus } from './runStatus';
 import type { SortKeys } from './sortKeys';
 import type { SourceSortKeys } from './sourceSortKeys';
@@ -20,7 +22,9 @@ 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 { TransformationTry } from './transformationTry';
 import type { TriggerType } from './triggerType';
 
 /**
@@ -127,6 +131,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 +161,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 +181,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 +202,83 @@ export type GetAuthenticationProps = {
 };
 
 /**
- * Properties for the `getAuthentications` method.
+ * Properties for the `getDestination` method.
+ */
+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 GetAuthenticationsProps = {
+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 +306,9 @@ export type GetAuthenticationsProps = {
 };
 
 /**
- * Properties for the `getDestination` method.
+ * Properties for the `listDestinations` method.
  */
-export type GetDestinationProps = {
-  /**
-   * Unique identifier of a destination.
-   */
-  destinationID: string;
-};
-
-/**
- * Properties for the `getDestinations` method.
- */
-export type GetDestinationsProps = {
+export type ListDestinationsProps = {
   /**
    * Number of items per page.
    */
@@ -238,23 +336,9 @@ export type GetDestinationsProps = {
 };
 
 /**
- * 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 `getEvents` method.
+ * Properties for the `listEvents` method.
  */
-export type GetEventsProps = {
+export type ListEventsProps = {
   /**
    * Unique identifier of a task run.
    */
@@ -294,19 +378,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 +416,9 @@ export type GetRunsProps = {
 };
 
 /**
- * Properties for the `getSource` method.
- */
-export type GetSourceProps = {
-  /**
-   * Unique identifier of a source.
-   */
-  sourceID: string;
-};
-
-/**
- * Properties for the `getSources` method.
+ * Properties for the `listSources` method.
  */
-export type GetSourcesProps = {
+export type ListSourcesProps = {
   /**
    * Number of items per page.
    */
@@ -382,19 +446,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,19 +530,17 @@ export type GetTasksProps = {
 };
 
 /**
- * Properties for the `getTransformation` method.
+ * Properties for the `listTransformations` method.
  */
-export type GetTransformationProps = {
+export type ListTransformationsProps = {
   /**
-   * Unique identifier of a transformation.
+   * Number of items per page.
    */
-  transformationID: string;
-};
-
-/**
- * Properties for the `getTransformations` method.
- */
-export type GetTransformationsProps = {
+  itemsPerPage?: number;
+  /**
+   * Page number of the paginated API response.
+   */
+  page?: number;
   /**
    * Property by which to sort the list.
    */
@@ -457,6 +551,34 @@ export type GetTransformationsProps = {
   order?: OrderKeys;
 };
 
+/**
+ * Properties for the `pushTask` method.
+ */
+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.
+   */
+  batchWriteParams: BatchWriteParams;
+};
+
+/**
+ * Properties for the `runSource` method.
+ */
+export type RunSourceProps = {
+  /**
+   * Unique identifier of a source.
+   */
+  sourceID: string;
+  /**
+   *
+   */
+  runSourcePayload?: RunSourcePayload;
+};
+
 /**
  * Properties for the `runTask` method.
  */
@@ -467,6 +589,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.
  */
@@ -477,6 +609,17 @@ export type TriggerDockerSourceDiscoverProps = {
   sourceID: string;
 };
 
+/**
+ * Properties for the `tryTransformationBeforeUpdate` method.
+ */
+export type TryTransformationBeforeUpdateProps = {
+  /**
+   * Unique identifier of a transformation.
+   */
+  transformationID: string;
+  transformationTry: TransformationTry;
+};
+
 /**
  * Properties for the `updateAuthentication` method.
  */
@@ -521,6 +664,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/destination.ts

@@ -35,4 +35,6 @@ export type Destination = {
    * Universally unique identifier (UUID) of an authentication resource.
    */
   authenticationID?: string;
+
+  transformationIDs?: string[];
 };

package/model/destinationCreate.ts

@@ -20,4 +20,6 @@ export type DestinationCreate = {
    * Universally unique identifier (UUID) of an authentication resource.
    */
   authenticationID?: string;
+
+  transformationIDs?: string[];
 };

package/model/destinationInput.ts

@@ -1,6 +1,5 @@
 // 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 { DestinationIndexName } from './destinationIndexName';
-import type { DestinationIndexPrefix } from './destinationIndexPrefix';
 
-export type DestinationInput = DestinationIndexName | DestinationIndexPrefix;
+export type DestinationInput = DestinationIndexName;

package/model/destinationUpdate.ts

@@ -20,4 +20,6 @@ export type DestinationUpdate = {
    * Universally unique identifier (UUID) of an authentication resource.
    */
   authenticationID?: string;
+
+  transformationIDs?: string[];
 };

package/model/dockerStreams.ts

@@ -0,0 +1,17 @@
+// 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 { DockerStreamsSyncMode } from './dockerStreamsSyncMode';
+
+export type DockerStreams = {
+  /**
+   * The name of the stream to fetch the data from (e.g. Table name).
+   */
+  name: string;
+
+  /**
+   * The properties of the stream to select (e.g. Column).
+   */
+  properties?: string[];
+
+  syncMode: DockerStreamsSyncMode;
+};

package/model/dockerStreamsInput.ts

@@ -0,0 +1,10 @@
+// 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 { DockerStreams } from './dockerStreams';
+
+/**
+ * The selected streams of a singer or airbyte connector.
+ */
+export type DockerStreamsInput = {
+  streams: DockerStreams[];
+};

package/model/dockerStreamsSyncMode.ts

@@ -0,0 +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.
+
+/**
+ * The strategy to use to fetch the data.
+ */
+export type DockerStreamsSyncMode = 'fullTable' | 'incremental';

package/model/entityType.ts

@@ -0,0 +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.
+
+/**
+ * Type of entity to update.
+ */
+export type EntityType = 'collection' | 'product';

package/model/generateTransformationCodePayload.ts

@@ -0,0 +1,9 @@
+// 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 type GenerateTransformationCodePayload = {
+  id: string;
+
+  systemPrompt?: string;
+
+  userPrompt: string;
+};

package/model/generateTransformationCodeResponse.ts

@@ -0,0 +1,5 @@
+// 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 type GenerateTransformationCodeResponse = {
+  generatedCode?: string;
+};

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';
@@ -32,7 +35,6 @@ export * from './destination';
 export * from './destinationCreate';
 export * from './destinationCreateResponse';
 export * from './destinationIndexName';
-export * from './destinationIndexPrefix';
 export * from './destinationInput';
 export * from './destinationSearch';
 export * from './destinationSortKeys';
@@ -41,16 +43,23 @@ export * from './destinationUpdate';
 export * from './destinationUpdateResponse';
 export * from './dockerImageType';
 export * from './dockerRegistry';
+export * from './dockerStreams';
+export * from './dockerStreamsInput';
+export * from './dockerStreamsSyncMode';
+export * from './entityType';
 export * from './errorBase';
 export * from './event';
 export * from './eventSortKeys';
 export * from './eventStatus';
 export * from './eventType';
+export * from './generateTransformationCodePayload';
+export * from './generateTransformationCodeResponse';
 export * from './listAuthenticationsResponse';
 export * from './listDestinationsResponse';
 export * from './listEventsResponse';
 export * from './listSourcesResponse';
 export * from './listTasksResponse';
+export * from './listTasksResponseV1';
 export * from './listTransformationsResponse';
 export * from './mappingFieldDirective';
 export * from './mappingFormatSchema';
@@ -58,7 +67,7 @@ export * from './mappingInput';
 export * from './mappingKitAction';
 export * from './mappingTypeCSV';
 export * from './methodType';
-export * from './onDemandDateUtilsInput';
+export * from './model';
 export * from './onDemandTrigger';
 export * from './onDemandTriggerInput';
 export * from './onDemandTriggerType';
@@ -75,9 +84,10 @@ export * from './runProgress';
 export * from './runReasonCode';
 export * from './runResponse';
 export * from './runSortKeys';
+export * from './runSourcePayload';
+export * from './runSourceResponse';
 export * from './runStatus';
 export * from './runType';
-export * from './scheduleDateUtilsInput';
 export * from './scheduleTrigger';
 export * from './scheduleTriggerInput';
 export * from './scheduleTriggerType';
@@ -108,27 +118,31 @@ export * from './sourceUpdateInput';
 export * from './sourceUpdateResponse';
 export * from './sourceUpdateShopify';
 export * from './sourceWatchResponse';
+export * from './streamingInput';
 export * from './streamingTrigger';
 export * from './streamingTriggerType';
-export * from './streamingUtilsInput';
 export * from './subscriptionTrigger';
 export * from './subscriptionTriggerType';
 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';
+export * from './transformationError';
+export * from './transformationModels';
 export * from './transformationSearch';
 export * from './transformationTry';
 export * from './transformationTryResponse';
-export * from './transformationTryResponseError';
 export * from './transformationUpdateResponse';
 export * from './trigger';
 export * from './triggerType';

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/model.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.
+
+export type Model = {
+  fullname: string;
+
+  modelName: string;
+
+  systemPrompt: string;
+
+  id: string;
+
+  provider: string;
+};