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

package/model/sortKeys.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.
+
+/**
+ * Property by which to sort the list.
+ */
+export type SortKeys = 'createdAt' | 'name' | 'type' | 'updatedAt';

package/model/source.ts

@@ -21,12 +21,12 @@ export type Source = {
   authenticationID?: string;
 
   /**
-   * Date of creation in RFC3339 format.
+   * Date of creation in RFC 3339 format.
    */
   createdAt: string;
 
   /**
-   * Date of last update in RFC3339 format.
+   * Date of last update in RFC 3339 format.
    */
   updatedAt?: string;
 };

package/model/sourceCreateResponse.ts

@@ -12,7 +12,7 @@ export type SourceCreateResponse = {
   name: string;
 
   /**
-   * Date of creation in RFC3339 format.
+   * Date of creation in RFC 3339 format.
    */
   createdAt: string;
 };

package/model/sourceUpdateResponse.ts

@@ -12,7 +12,7 @@ export type SourceUpdateResponse = {
   name: string;
 
   /**
-   * Date of last update in RFC3339 format.
+   * Date of last update in RFC 3339 format.
    */
   updatedAt: 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/sourceWatchResponse.ts

@@ -0,0 +1,25 @@
+// 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 { Event } from './event';
+
+export type SourceWatchResponse = {
+  /**
+   * Universally unique identifier (UUID) of a task run.
+   */
+  runID?: string;
+
+  /**
+   * Depending on the source type, the validation returns sampling data of your source (JSON, CSV, BigQuery).
+   */
+  data?: Array<Record<string, any>>;
+
+  /**
+   * In case of error, observability events will be added to the response, if any.
+   */
+  events?: Event[];
+
+  /**
+   * A message describing the outcome of a validate run.
+   */
+  message: string;
+};

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

@@ -37,12 +37,17 @@ export type Task = {
   action: ActionType;
 
   /**
-   * Date of creation in RFC3339 format.
+   * 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 RFC3339 format.
+   * Date of last update in RFC 3339 format.
    */
   updatedAt?: string;
 };

package/model/taskCreate.ts

@@ -33,4 +33,9 @@ export type TaskCreate = {
   failureThreshold?: number;
 
   input?: TaskInput;
+
+  /**
+   * Date of the last cursor in RFC 3339 format.
+   */
+  cursor?: string;
 };

package/model/taskCreateResponse.ts

@@ -10,7 +10,7 @@ export type TaskCreateResponse = {
   taskID: string;
 
   /**
-   * Date of creation in RFC3339 format.
+   * Date of creation in RFC 3339 format.
    */
   createdAt: 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/taskUpdateResponse.ts

@@ -10,7 +10,7 @@ export type TaskUpdateResponse = {
   taskID: string;
 
   /**
-   * Date of last update in RFC3339 format.
+   * Date of last update in RFC 3339 format.
    */
   updatedAt: string;
 };

package/model/transformation.ts

@@ -0,0 +1,33 @@
+// 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 Transformation = {
+  /**
+   * Universally unique identifier (UUID) of a transformation.
+   */
+  transformationID: string;
+
+  /**
+   * The source code of the transformation.
+   */
+  code: string;
+
+  /**
+   * The uniquely identified name of your transformation.
+   */
+  name: string;
+
+  /**
+   * A descriptive name for your transformation of what it does.
+   */
+  description?: string;
+
+  /**
+   * Date of creation in RFC 3339 format.
+   */
+  createdAt: string;
+
+  /**
+   * Date of last update in RFC 3339 format.
+   */
+  updatedAt?: string;
+};

package/model/transformationCreate.ts

@@ -0,0 +1,21 @@
+// 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.
+
+/**
+ * API request body for creating a transformation.
+ */
+export type TransformationCreate = {
+  /**
+   * The source code of the transformation.
+   */
+  code: string;
+
+  /**
+   * The uniquely identified name of your transformation.
+   */
+  name: string;
+
+  /**
+   * A descriptive name for your transformation of what it does.
+   */
+  description?: string;
+};

package/model/transformationCreateResponse.ts

@@ -0,0 +1,16 @@
+// 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.
+
+/**
+ * API response for creating a transformation.
+ */
+export type TransformationCreateResponse = {
+  /**
+   * Universally unique identifier (UUID) of a transformation.
+   */
+  transformationID: string;
+
+  /**
+   * Date of creation in RFC 3339 format.
+   */
+  createdAt: string;
+};

package/model/transformationSearch.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 TransformationSearch = {
+  transformationsIDs: string[];
+};

package/model/{dockerSourceDiscover.ts → transformationTry.ts}

@@ -1,13 +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 DockerSourceDiscover = {
+export type TransformationTry = {
   /**
-   * Universally unique identifier (UUID) of a task run.
+   * The source code of the transformation.
    */
-  runID: string;
+  code: string;
 
   /**
-   * Date of creation in RFC3339 format.
+   * The record to apply the given code to.
    */
-  createdAt: string;
+  sampleRecord: Record<string, any>;
 };

package/model/transformationTryResponse.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 { TransformationTryResponseError } from './transformationTryResponseError';
+
+export type TransformationTryResponse = {
+  /**
+   * The array of records returned by the transformation service.
+   */
+  payloads: Array<Record<string, any>>;
+
+  error?: TransformationTryResponseError;
+};

package/model/transformationTryResponseError.ts

@@ -0,0 +1,16 @@
+// 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 error if the transformation failed.
+ */
+export type TransformationTryResponseError = {
+  /**
+   * The error status code.
+   */
+  code?: number;
+
+  /**
+   * A descriptive message explaining the failure.
+   */
+  message?: string;
+};

package/model/transformationUpdateResponse.ts

@@ -0,0 +1,16 @@
+// 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.
+
+/**
+ * API response for updating a transformation.
+ */
+export type TransformationUpdateResponse = {
+  /**
+   * Universally unique identifier (UUID) of a transformation.
+   */
+  transformationID: string;
+
+  /**
+   * Date of last update in RFC 3339 format.
+   */
+  updatedAt: string;
+};

package/model/window.ts

@@ -5,12 +5,12 @@
  */
 export type Window = {
   /**
-   * Date in RFC3339 format representing the oldest data in the time window.
+   * Date in RFC 3339 format representing the oldest data in the time window.
    */
   startDate: string;
 
   /**
-   * Date in RFC3339 format representing the newest data in the time window.
+   * Date in RFC 3339 format representing the newest data in the time window.
    */
   endDate: string;
 };

package/package.json

@@ -1,8 +1,11 @@
 {
   "name": "@algolia/ingestion",
-  "version": "1.0.0-beta.1",
+  "version": "1.0.0-beta.11",
   "description": "JavaScript client for ingestion",
-  "repository": "algolia/algoliasearch-client-javascript",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/algolia/algoliasearch-client-javascript.git"
+  },
   "license": "MIT",
   "author": "Algolia",
   "type": "module",
@@ -39,14 +42,14 @@
     "clean": "rm -rf ./dist || true"
   },
   "dependencies": {
-    "@algolia/client-common": "5.0.0-beta.1",
-    "@algolia/requester-browser-xhr": "5.0.0-beta.1",
-    "@algolia/requester-node-http": "5.0.0-beta.1"
+    "@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"
   },
   "devDependencies": {
-    "@types/node": "20.12.7",
-    "rollup": "4.14.2",
-    "typescript": "5.4.5"
+    "@types/node": "20.14.10",
+    "rollup": "4.18.1",
+    "typescript": "5.5.3"
   },
   "engines": {
     "node": ">= 14.0.0"

package/dist/model/dockerSourceDiscover.d.ts

@@ -1,11 +0,0 @@
-export type DockerSourceDiscover = {
-    /**
-     * Universally unique identifier (UUID) of a task run.
-     */
-    runID: string;
-    /**
-     * Date of creation in RFC3339 format.
-     */
-    createdAt: string;
-};
-//# sourceMappingURL=dockerSourceDiscover.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"dockerSourceDiscover.d.ts","sourceRoot":"","sources":["../../model/dockerSourceDiscover.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,oBAAoB,GAAG;IACjC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC"}

package/dist/model/dockerSourceStreams.d.ts

@@ -1,4 +0,0 @@
-export type DockerSourceStreams = {
-    streams: Array<Record<string, any>>;
-};
-//# sourceMappingURL=dockerSourceStreams.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"dockerSourceStreams.d.ts","sourceRoot":"","sources":["../../model/dockerSourceStreams.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,mBAAmB,GAAG;IAChC,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC;CACrC,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 RFC3339 format of the extracted data from Big Query.
-     */
-    startDate: string;
-    /**
-     * Latest date in RFC3339 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/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 RFC3339 format of the extracted data from Big Query.
-   */
-  startDate: string;
-
-  /**
-   * Latest date in RFC3339 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;
-};