@algolia/ingestion 1.0.0-alpha.82 → 1.0.0-alpha.84

package/model/sourceType.ts

@@ -7,4 +7,6 @@ export type SourceType =
   | 'csv'
   | 'docker'
   | 'ga4BigqueryExport'
-  | 'json';
+  | 'json'
+  | 'sfcc'
+  | 'shopify';

package/model/sourceUpdate.ts

@@ -3,12 +3,15 @@
 import type { SourceUpdateInput } from './sourceUpdateInput';
 
 export type SourceUpdate = {
+  /**
+   * Descriptive name of the source.
+   */
   name?: string;
 
   input?: SourceUpdateInput;
 
   /**
-   * The authentication UUID.
+   * Universally unique identifier (UUID) of an authentication resource.
    */
   authenticationID?: string;
 };

package/model/sourceUpdateCommercetools.ts

@@ -3,20 +3,17 @@
 import type { CommercetoolsCustomFields } from './commercetoolsCustomFields';
 
 export type SourceUpdateCommercetools = {
-  /**
-   * Unique and immutable key of the referenced Store.
-   */
   storeKeys?: string[];
 
   /**
-   * Array of locales that must match the following pattern: ^[a-z]{2}(-[A-Z]{2})?$. For example [\"fr-FR\", \"en\"].
+   * Locales for your commercetools stores.
    */
   locales?: string[];
 
   url?: string;
 
   /**
-   * Determines the value that will be stored in the Algolia record if there\'s no inventory information on the product.
+   * Whether a fallback value is stored in the Algolia record if there\'s no inventory information about the product.
    */
   fallbackIsInStockValue?: boolean;
 

package/model/sourceUpdateDocker.ts

@@ -6,17 +6,17 @@ export type SourceUpdateDocker = {
   registry?: DockerRegistry;
 
   /**
-   * The name of the image to pull.
+   * Docker image name.
    */
   image?: string;
 
   /**
-   * The version of the image, defaults to `latest`.
+   * Docker image version.
    */
   version?: string;
 
   /**
-   * The configuration of the spec.
+   * Configuration of the spec.
    */
   configuration: Record<string, any>;
 };

package/model/sourceUpdateResponse.ts

@@ -2,14 +2,17 @@
 
 export type SourceUpdateResponse = {
   /**
-   * The source UUID.
+   * 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/streamingTrigger.ts

@@ -3,7 +3,7 @@
 import type { StreamingTriggerType } from './streamingTriggerType';
 
 /**
- * The trigger input for a task of type \'streaming\'.
+ * Trigger input for continuously running tasks.
  */
 export type StreamingTrigger = {
   type: StreamingTriggerType;

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

package/model/streamingUtilsInput.ts

@@ -3,7 +3,7 @@
 import type { MappingInput } from './mappingInput';
 
 /**
- * The input for a `streaming` task whose source is of type `ga4BigqueryExport` and for which extracted data is continuously streamed.
+ * 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

@@ -3,7 +3,7 @@
 import type { SubscriptionTriggerType } from './subscriptionTriggerType';
 
 /**
- * The trigger input for a task of type \'subscription\'.
+ * Trigger input for subscription tasks.
  */
 export type SubscriptionTrigger = {
   type: SubscriptionTriggerType;

package/model/subscriptionTriggerType.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.
 
 /**
- * A task which is triggered by an external subscription (e.g. Webhook).
+ * Task runs after receiving subscribed event.
  */
 export type SubscriptionTriggerType = 'subscription';

package/model/task.ts

@@ -6,17 +6,17 @@ import type { Trigger } from './trigger';
 
 export type Task = {
   /**
-   * The task UUID.
+   * Universally unique identifier (UUID) of a task.
    */
   taskID: string;
 
   /**
-   * The source UUID.
+   * Universally uniqud identifier (UUID) of a source.
    */
   sourceID: string;
 
   /**
-   * The destination UUID.
+   * Universally unique identifier (UUID) of a destination resource.
    */
   destinationID: string;
 
@@ -25,24 +25,24 @@ export type Task = {
   input?: TaskInput;
 
   /**
-   * Whether the task is enabled or not.
+   * Whether the task is enabled.
    */
   enabled: boolean;
 
   /**
-   * A percentage representing the accepted failure threshold to determine if a `run` succeeded or not.
+   * 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

@@ -5,16 +5,16 @@ import type { TaskCreateTrigger } from './taskCreateTrigger';
 import type { TaskInput } from './taskInput';
 
 /**
- * The payload for a task creation.
+ * API request body for creating a task.
  */
 export type TaskCreate = {
   /**
-   * The source UUID.
+   * Universally uniqud identifier (UUID) of a source.
    */
   sourceID: string;
 
   /**
-   * The destination UUID.
+   * Universally unique identifier (UUID) of a destination resource.
    */
   destinationID: string;
 
@@ -23,12 +23,12 @@ export type TaskCreate = {
   action: ActionType;
 
   /**
-   * Whether the task is enabled or not.
+   * Whether the task is enabled.
    */
   enabled?: boolean;
 
   /**
-   * A percentage representing the accepted failure threshold to determine if a `run` succeeded or not.
+   * Maximum accepted percentage of failures for a task run to finish successfully.
    */
   failureThreshold?: number;
 

package/model/taskCreateResponse.ts

@@ -1,16 +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 response from the API after a task creation.
+ * API response for creating a task.
  */
 export type TaskCreateResponse = {
   /**
-   * The task UUID.
+   * Universally unique identifier (UUID) of a task.
    */
   taskID: string;
 
   /**
-   * Date of creation (RFC3339 format).
+   * Date of creation in RFC3339 format.
    */
   createdAt: string;
 };

package/model/taskInput.ts

@@ -4,6 +4,9 @@ import type { OnDemandDateUtilsInput } from './onDemandDateUtilsInput';
 import type { ScheduleDateUtilsInput } from './scheduleDateUtilsInput';
 import type { StreamingUtilsInput } from './streamingUtilsInput';
 
+/**
+ * Configuration of the task, depending on its type.
+ */
 export type TaskInput =
   | OnDemandDateUtilsInput
   | ScheduleDateUtilsInput

package/model/taskSortKeys.ts

@@ -1,7 +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.
 
 /**
- * Used to sort the Task list endpoint.
+ * Property by which to sort the list of tasks.
  */
 export type TaskSortKeys =
   | 'action'

package/model/taskUpdate.ts

@@ -4,11 +4,11 @@ import type { TaskInput } from './taskInput';
 import type { TriggerUpdateInput } from './triggerUpdateInput';
 
 /**
- * The payload for a task update.
+ * API request body for updating a task.
  */
 export type TaskUpdate = {
   /**
-   * The destination UUID.
+   * Universally unique identifier (UUID) of a destination resource.
    */
   destinationID?: string;
 
@@ -17,12 +17,12 @@ export type TaskUpdate = {
   input?: TaskInput;
 
   /**
-   * Whether the task is enabled or not.
+   * Whether the task is enabled.
    */
   enabled?: boolean;
 
   /**
-   * A percentage representing the accepted failure threshold to determine if a `run` succeeded or not.
+   * Maximum accepted percentage of failures for a task run to finish successfully.
    */
   failureThreshold?: number;
 };

package/model/taskUpdateResponse.ts

@@ -1,16 +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 response from the API after a task update.
+ * API response for updating a task.
  */
 export type TaskUpdateResponse = {
   /**
-   * The task UUID.
+   * 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

@@ -5,6 +5,9 @@ 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

package/model/triggerType.ts

@@ -1,7 +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.
 
 /**
- * The type of the task reflect how it can be used:   - onDemand: a task that runs manually   - schedule: a task that runs regularly, following a given cron expression   - subscription: a task that runs after a subscription event is received from an integration (e.g. Webhook).   - streaming: a task that runs continuously.
+ * Task trigger, describing when a task should run.  <dl> <dt><code>onDemand</code></dt> <dd>  Manually trigger the task with the `/run` endpoint.  </dd> <dt><code>schedule</code></dt> <dd>  Regularly trigger the task on a `cron` schedule.  </dd>  <dt><code>subscription</code></dt>  <dd>  Trigger the task after an event is received, such as, a webhook.  </dd>  <dt><code>streaming</code></dt>  <dd>  Run the task continuously.  </dd> </dl>.
  */
 export type TriggerType =
   | 'onDemand'

package/model/triggerUpdateInput.ts

@@ -1,11 +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.
 
 /**
- * The trigger input for a task update.
+ * Trigger for a task update.
  */
 export type TriggerUpdateInput = {
   /**
-   * A cron expression that represent at which regularity the task should run.
+   * Cron expression for the task\'s schedule.
    */
   cron: string;
 };

package/model/window.ts

@@ -1,16 +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 window parameter represents the holds the dates used to query the Observability data from the database in a given window.
+ * Time window by which to filter the observability data.
  */
 export type Window = {
   /**
-   * A date in format RFC3339 representing the oldest possible data in query window.
+   * Date in RFC3339 format representing the oldest data in the time window.
    */
   startDate: string;
 
   /**
-   * A date in format RFC3339 representing the newest possible data in query window.
+   * Date in RFC3339 format representing the newest data in the time window.
    */
   endDate: string;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@algolia/ingestion",
-  "version": "1.0.0-alpha.82",
+  "version": "1.0.0-alpha.84",
   "description": "JavaScript client for ingestion",
   "repository": "algolia/algoliasearch-client-javascript",
   "license": "MIT",
@@ -39,14 +39,14 @@
     "clean": "rm -rf ./dist || true"
   },
   "dependencies": {
-    "@algolia/client-common": "5.0.0-alpha.109",
-    "@algolia/requester-browser-xhr": "5.0.0-alpha.109",
-    "@algolia/requester-node-http": "5.0.0-alpha.109"
+    "@algolia/client-common": "5.0.0-alpha.111",
+    "@algolia/requester-browser-xhr": "5.0.0-alpha.111",
+    "@algolia/requester-node-http": "5.0.0-alpha.111"
   },
   "devDependencies": {
-    "@types/node": "20.11.28",
-    "rollup": "4.13.0",
-    "typescript": "5.4.2"
+    "@types/node": "20.11.30",
+    "rollup": "4.13.2",
+    "typescript": "5.4.3"
   },
   "engines": {
     "node": ">= 14.0.0"