@algolia/ingestion 1.0.0-beta.9 → 1.0.0

package/model/runSourcePayload.ts

@@ -0,0 +1,22 @@
+// 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 { EntityType } from './entityType';
+
+export type RunSourcePayload = {
+  /**
+   * List of index names to include in reidexing/update.
+   */
+  indexToInclude?: string[];
+
+  /**
+   * List of index names to exclude in reidexing/update.
+   */
+  indexToExclude?: string[];
+
+  /**
+   * List of entityID to update.
+   */
+  entityIDs?: string[];
+
+  entityType?: EntityType;
+};

package/model/runSourceResponse.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 RunSourceResponse = {
+  /**
+   * Map of taskID sent for reindex with the corresponding runID.
+   */
+  taskWithRunID: Record<string, string>;
+
+  /**
+   * Date of creation in RFC 3339 format.
+   */
+  createdAt: string;
+};

package/model/sourceUpdateShopify.ts

@@ -2,37 +2,7 @@
 
 export type SourceUpdateShopify = {
   /**
-   * Whether to index collection IDs.   If your store has `has_collection_search_page` set to true, collection IDs will be indexed even if `collectionIDIndexing` is false.
+   * Feature flags for the Shopify source.
    */
-  collectionIDIndexing?: boolean;
-
-  /**
-   * Whether to increase the number of indexed collections per product. If true, Algolia indexes 200 collections per product. If false, 100 collections per product are indexed.
-   */
-  increaseProductCollectionLimit?: boolean;
-
-  /**
-   * Whether to set the default price ratio to 1 if no sale price is present.  The price ratio is determined by the ratio: `sale_price` / `regular_price`. If no sale price is present, the price ratio would be 0. If `defaultPriceRatioAsOne` is true, the price ratio is indexed as 1 instead.
-   */
-  defaultPriceRatioAsOne?: boolean;
-
-  /**
-   * Whether to exclude out-of-stock variants when determining the `max_variant_price` and `min_variant_price` attributes.
-   */
-  excludeOOSVariantsForPriceAtTRS?: boolean;
-
-  /**
-   * Whether to include an inventory with every variant for every product record.
-   */
-  includeVariantsInventory?: boolean;
-
-  /**
-   * Whether to include collection IDs and handles in the product records.
-   */
-  hasCollectionSearchPage?: boolean;
-
-  /**
-   * Whether to convert tags on products to named tags.  To learn more, see [Named tags](https://www.algolia.com/doc/integration/shopify/sending-and-managing-data/named-tags).
-   */
-  productNamedTags?: boolean;
+  featureFlags?: Record<string, any>;
 };

package/model/{streamingUtilsInput.ts → streamingInput.ts}

@@ -5,6 +5,6 @@ import type { MappingInput } from './mappingInput';
 /**
  * Input for a `streaming` task whose source is of type `ga4BigqueryExport` and for which extracted data is continuously streamed.
  */
-export type StreamingUtilsInput = {
+export type StreamingInput = {
   mapping: MappingInput;
 };

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/taskInput.ts

@@ -1,15 +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 { OnDemandDateUtilsInput } from './onDemandDateUtilsInput';
-import type { ScheduleDateUtilsInput } from './scheduleDateUtilsInput';
+import type { DockerStreamsInput } from './dockerStreamsInput';
 import type { ShopifyInput } from './shopifyInput';
-import type { StreamingUtilsInput } from './streamingUtilsInput';
+import type { StreamingInput } from './streamingInput';
 
 /**
  * Configuration of the task, depending on its type.
  */
-export type TaskInput =
-  | OnDemandDateUtilsInput
-  | ScheduleDateUtilsInput
-  | ShopifyInput
-  | StreamingUtilsInput;
+export type TaskInput = DockerStreamsInput | ShopifyInput | StreamingInput;

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/model/transformation.ts

@@ -6,6 +6,11 @@ export type Transformation = {
    */
   transformationID: string;
 
+  /**
+   * The authentications associated for the current transformation.
+   */
+  authenticationIDs?: string[];
+
   /**
    * The source code of the transformation.
    */
@@ -19,7 +24,7 @@ export type Transformation = {
   /**
    * A descriptive name for your transformation of what it does.
    */
-  description: string;
+  description?: string;
 
   /**
    * Date of creation in RFC 3339 format.

package/model/transformationCreate.ts

@@ -17,5 +17,10 @@ export type TransformationCreate = {
   /**
    * A descriptive name for your transformation of what it does.
    */
-  description: string;
+  description?: string;
+
+  /**
+   * The authentications associated for the current transformation.
+   */
+  authenticationIDs?: string[];
 };

package/model/{transformationTryResponseError.ts → transformationError.ts}

@@ -3,7 +3,7 @@
 /**
  * The error if the transformation failed.
  */
-export type TransformationTryResponseError = {
+export type TransformationError = {
   /**
    * The error status code.
    */

package/model/transformationModels.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 { Model } from './model';
+
+/**
+ * List of available AI models for transformation purposes.
+ */
+export type TransformationModels = {
+  llms: Model[];
+};

package/model/transformationSearch.ts

@@ -1,5 +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 TransformationSearch = {
-  transformationsIDs: string[];
+  transformationIDs: string[];
 };

package/model/transformationTry.ts

@@ -1,5 +1,7 @@
 // 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 { AuthenticationCreate } from './authenticationCreate';
+
 export type TransformationTry = {
   /**
    * The source code of the transformation.
@@ -10,4 +12,6 @@ export type TransformationTry = {
    * The record to apply the given code to.
    */
   sampleRecord: Record<string, any>;
+
+  authentications?: AuthenticationCreate[];
 };

package/model/transformationTryResponse.ts

@@ -1,6 +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 { TransformationTryResponseError } from './transformationTryResponseError';
+import type { TransformationError } from './transformationError';
 
 export type TransformationTryResponse = {
   /**
@@ -8,5 +8,5 @@ export type TransformationTryResponse = {
    */
   payloads: Array<Record<string, any>>;
 
-  error?: TransformationTryResponseError;
+  error?: TransformationError;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@algolia/ingestion",
-  "version": "1.0.0-beta.9",
+  "version": "1.0.0",
   "description": "JavaScript client for ingestion",
   "repository": {
     "type": "git",
@@ -42,14 +42,14 @@
     "clean": "rm -rf ./dist || true"
   },
   "dependencies": {
-    "@algolia/client-common": "5.0.0-beta.10",
-    "@algolia/requester-browser-xhr": "5.0.0-beta.10",
-    "@algolia/requester-node-http": "5.0.0-beta.10"
+    "@algolia/client-common": "5.0.0",
+    "@algolia/requester-browser-xhr": "5.0.0",
+    "@algolia/requester-node-http": "5.0.0"
   },
   "devDependencies": {
-    "@types/node": "20.14.10",
-    "rollup": "4.18.0",
-    "typescript": "5.5.3"
+    "@types/node": "22.2.0",
+    "rollup": "4.20.0",
+    "typescript": "5.5.4"
   },
   "engines": {
     "node": ">= 14.0.0"

package/dist/model/destinationIndexPrefix.d.ts

@@ -1,7 +0,0 @@
-export type DestinationIndexPrefix = {
-    /**
-     * String added to the beginning of all indices created by this destination.
-     */
-    indexPrefix: string;
-};
-//# sourceMappingURL=destinationIndexPrefix.d.ts.map

package/dist/model/destinationIndexPrefix.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"destinationIndexPrefix.d.ts","sourceRoot":"","sources":["../../model/destinationIndexPrefix.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,sBAAsB,GAAG;IACnC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC"}

package/dist/model/onDemandDateUtilsInput.d.ts

@@ -1,16 +0,0 @@
-import type { MappingInput } from './mappingInput';
-/**
- * Input for a manually-triggered task whose source is of type `bigquery` and for which extracted data spans a given time range.
- */
-export type OnDemandDateUtilsInput = {
-    /**
-     * Earliest date in RFC 3339 format of the extracted data from Big Query.
-     */
-    startDate: string;
-    /**
-     * Latest date in RFC 3339 format of the extracted data from Big Query.
-     */
-    endDate: string;
-    mapping?: MappingInput;
-};
-//# sourceMappingURL=onDemandDateUtilsInput.d.ts.map

package/dist/model/onDemandDateUtilsInput.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"onDemandDateUtilsInput.d.ts","sourceRoot":"","sources":["../../model/onDemandDateUtilsInput.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEnD;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB,OAAO,CAAC,EAAE,YAAY,CAAC;CACxB,CAAC"}

package/dist/model/scheduleDateUtilsInput.d.ts

@@ -1,12 +0,0 @@
-import type { MappingInput } from './mappingInput';
-/**
- * Input for scheduled tasks whose source is of type `bigquery` and for which extracted data spans a fixed number of days.
- */
-export type ScheduleDateUtilsInput = {
-    /**
-     * Number of days in the past until the current day for which to extract Big Query data.
-     */
-    timeframe: number;
-    mapping?: MappingInput;
-};
-//# sourceMappingURL=scheduleDateUtilsInput.d.ts.map

package/dist/model/scheduleDateUtilsInput.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"scheduleDateUtilsInput.d.ts","sourceRoot":"","sources":["../../model/scheduleDateUtilsInput.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEnD;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB,OAAO,CAAC,EAAE,YAAY,CAAC;CACxB,CAAC"}

package/dist/model/streamingUtilsInput.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"streamingUtilsInput.d.ts","sourceRoot":"","sources":["../../model/streamingUtilsInput.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEnD;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,OAAO,EAAE,YAAY,CAAC;CACvB,CAAC"}

package/dist/model/transformationTryResponseError.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"transformationTryResponseError.d.ts","sourceRoot":"","sources":["../../model/transformationTryResponseError.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,8BAA8B,GAAG;IAC3C;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC"}

package/model/onDemandDateUtilsInput.ts

@@ -1,20 +0,0 @@
-// 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 { MappingInput } from './mappingInput';
-
-/**
- * Input for a manually-triggered task whose source is of type `bigquery` and for which extracted data spans a given time range.
- */
-export type OnDemandDateUtilsInput = {
-  /**
-   * Earliest date in RFC 3339 format of the extracted data from Big Query.
-   */
-  startDate: string;
-
-  /**
-   * Latest date in RFC 3339 format of the extracted data from Big Query.
-   */
-  endDate: string;
-
-  mapping?: MappingInput;
-};

package/model/scheduleDateUtilsInput.ts

@@ -1,15 +0,0 @@
-// 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 { MappingInput } from './mappingInput';
-
-/**
- * Input for scheduled tasks whose source is of type `bigquery` and for which extracted data spans a fixed number of days.
- */
-export type ScheduleDateUtilsInput = {
-  /**
-   * Number of days in the past until the current day for which to extract Big Query data.
-   */
-  timeframe: number;
-
-  mapping?: MappingInput;
-};