@algolia/ingestion 1.0.0-alpha.9 → 1.0.0-beta.2

package/model/sourceUpdateResponse.ts

@@ -1,12 +1,18 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// 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 SourceUpdateResponse = {
+  /**
+   * Universally uniqud identifier (UUID) of a source.
+   */
   sourceID: string;
 
+  /**
+   * Descriptive name of the source.
+   */
   name: string;
 
   /**
-   * Date of last update (RFC3339 format).
+   * Date of last update in RFC3339 format.
    */
   updatedAt: string;
 };

package/model/sourceUpdateShopify.ts

@@ -0,0 +1,38 @@
+// 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 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.
+   */
+  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;
+};

package/model/streamingTrigger.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 { StreamingTriggerType } from './streamingTriggerType';
+
+/**
+ * Trigger input for continuously running tasks.
+ */
+export type StreamingTrigger = {
+  type: StreamingTriggerType;
+};

package/model/streamingTriggerType.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.
+
+/**
+ * Task runs continuously.
+ */
+export type StreamingTriggerType = 'streaming';

package/model/streamingUtilsInput.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 { 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 = {
+  mapping: MappingInput;
+};

package/model/subscriptionTrigger.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 { SubscriptionTriggerType } from './subscriptionTriggerType';
+
+/**
+ * Trigger input for subscription tasks.
+ */
+export type SubscriptionTrigger = {
+  type: SubscriptionTriggerType;
+};

package/model/subscriptionTriggerType.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.
+
+/**
+ * Task runs after receiving subscribed event.
+ */
+export type SubscriptionTriggerType = 'subscription';

package/model/task.ts

@@ -1,28 +1,48 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// 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';
 
 export type Task = {
+  /**
+   * 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;
+  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 creation (RFC3339 format).
+   * Date of creation in RFC3339 format.
    */
   createdAt: string;
 
   /**
-   * Date of last update (RFC3339 format).
+   * Date of last update in RFC3339 format.
    */
   updatedAt?: string;
 };

package/model/taskCreate.ts

@@ -1,16 +1,36 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// 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 { TriggerInput } from './triggerInput';
+import type { TaskCreateTrigger } from './taskCreateTrigger';
+import type { TaskInput } from './taskInput';
 
+/**
+ * API request body for creating a task.
+ */
 export type TaskCreate = {
+  /**
+   * Universally uniqud identifier (UUID) of a source.
+   */
   sourceID: string;
 
+  /**
+   * Universally unique identifier (UUID) of a destination resource.
+   */
   destinationID: string;
 
-  trigger: TriggerInput;
+  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;
 };

package/model/taskCreateResponse.ts

@@ -1,10 +1,16 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// 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 task.
+ */
 export type TaskCreateResponse = {
+  /**
+   * Universally unique identifier (UUID) of a task.
+   */
   taskID: string;
 
   /**
-   * Date of creation (RFC3339 format).
+   * Date of creation in RFC3339 format.
    */
   createdAt: string;
 };

package/model/taskCreateTrigger.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 { OnDemandTriggerInput } from './onDemandTriggerInput';
+import type { ScheduleTriggerInput } from './scheduleTriggerInput';
+import type { StreamingTrigger } from './streamingTrigger';
+import type { SubscriptionTrigger } from './subscriptionTrigger';
+
+export type TaskCreateTrigger =
+  | OnDemandTriggerInput
+  | ScheduleTriggerInput
+  | StreamingTrigger
+  | SubscriptionTrigger;

package/model/taskInput.ts

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

package/model/taskSearch.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 TaskSearch = {
+  taskIDs: string[];
+};

package/model/taskSortKeys.ts

@@ -0,0 +1,11 @@
+// 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 of tasks.
+ */
+export type TaskSortKeys =
+  | 'action'
+  | 'createdAt'
+  | 'enabled'
+  | 'triggerType'
+  | 'updatedAt';

package/model/taskUpdate.ts

@@ -1,11 +1,28 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// 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 { TriggerInput } from './triggerInput';
+import type { TaskInput } from './taskInput';
+import type { TriggerUpdateInput } from './triggerUpdateInput';
 
+/**
+ * API request body for updating a task.
+ */
 export type TaskUpdate = {
+  /**
+   * Universally unique identifier (UUID) of a destination resource.
+   */
   destinationID?: string;
 
-  trigger?: TriggerInput;
+  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/taskUpdateResponse.ts

@@ -1,10 +1,16 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// 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 task.
+ */
 export type TaskUpdateResponse = {
+  /**
+   * Universally unique identifier (UUID) of a task.
+   */
   taskID: string;
 
   /**
-   * Date of last update (RFC3339 format).
+   * Date of last update in RFC3339 format.
    */
   updatedAt: string;
 };

package/model/trigger.ts

@@ -1,19 +1,15 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
-
-import type { TriggerType } from './triggerType';
-
-export type Trigger = {
-  type: TriggerType;
-
-  cron?: string;
-
-  /**
-   * The last time the task ran (`scheduled` or `on-demand`).
-   */
-  lastRun?: string;
-
-  /**
-   * The next scheduled run for the task (`scheduled`).
-   */
-  nextRun?: string;
-};
+// 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 { OnDemandTrigger } from './onDemandTrigger';
+import type { ScheduleTrigger } from './scheduleTrigger';
+import type { StreamingTrigger } from './streamingTrigger';
+import type { SubscriptionTrigger } from './subscriptionTrigger';
+
+/**
+ * Trigger that runs the task.
+ */
+export type Trigger =
+  | OnDemandTrigger
+  | ScheduleTrigger
+  | StreamingTrigger
+  | SubscriptionTrigger;

package/model/triggerType.ts

@@ -1,3 +1,10 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// 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 TriggerType = 'on_demand' | 'schedule' | 'subscription';
+/**
+ * Task trigger, describing when a task should run.  - `onDemand`.   Manually trigger the task with the `/run` endpoint.  - `schedule`.   Regularly trigger the task on a `cron` schedule.  - `subscription`.   Trigger the task after an event is received, such as, a webhook.  - `streaming`.   Run the task continuously.
+ */
+export type TriggerType =
+  | 'onDemand'
+  | 'schedule'
+  | 'streaming'
+  | 'subscription';

package/model/triggerUpdateInput.ts

@@ -0,0 +1,11 @@
+// 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.
+
+/**
+ * Trigger for a task update.
+ */
+export type TriggerUpdateInput = {
+  /**
+   * Cron expression for the task\'s schedule.
+   */
+  cron: string;
+};

package/model/window.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.
+
+/**
+ * Time window by which to filter the observability data.
+ */
+export type Window = {
+  /**
+   * Date in RFC3339 format representing the oldest data in the time window.
+   */
+  startDate: string;
+
+  /**
+   * Date in RFC3339 format representing the newest data in the time window.
+   */
+  endDate: string;
+};

package/package.json

@@ -1,17 +1,18 @@
 {
   "name": "@algolia/ingestion",
-  "version": "1.0.0-alpha.9",
+  "version": "1.0.0-beta.2",
   "description": "JavaScript client for ingestion",
   "repository": "algolia/algoliasearch-client-javascript",
   "license": "MIT",
   "author": "Algolia",
+  "type": "module",
   "exports": {
     ".": {
       "node": {
         "import": "./dist/ingestion.esm.node.js",
         "module": "./dist/ingestion.esm.node.js",
-        "require": "./dist/ingestion.cjs.js",
-        "default": "./dist/ingestion.cjs.js"
+        "require": "./dist/ingestion.cjs",
+        "default": "./dist/ingestion.cjs"
       },
       "default": {
         "umd": "./dist/ingestion.umd.js",
@@ -38,14 +39,14 @@
     "clean": "rm -rf ./dist || true"
   },
   "dependencies": {
-    "@algolia/client-common": "5.0.0-alpha.35",
-    "@algolia/requester-browser-xhr": "5.0.0-alpha.35",
-    "@algolia/requester-node-http": "5.0.0-alpha.35"
+    "@algolia/client-common": "5.0.0-beta.2",
+    "@algolia/requester-browser-xhr": "5.0.0-beta.2",
+    "@algolia/requester-node-http": "5.0.0-beta.2"
   },
   "devDependencies": {
-    "@types/node": "16.11.59",
-    "rollup": "2.79.1",
-    "typescript": "4.8.3"
+    "@types/node": "20.12.11",
+    "rollup": "4.17.2",
+    "typescript": "5.4.5"
   },
   "engines": {
     "node": ">= 14.0.0"