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

package/dist/model/sourceType.d.ts

@@ -1,2 +1,2 @@
-export type SourceType = 'bigcommerce' | 'bigquery' | 'commercetools' | 'csv' | 'docker' | 'ga4BigqueryExport' | 'json';
+export type SourceType = 'bigcommerce' | 'bigquery' | 'commercetools' | 'csv' | 'docker' | 'ga4BigqueryExport' | 'json' | 'sfcc' | 'shopify';
 //# sourceMappingURL=sourceType.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"sourceType.d.ts","sourceRoot":"","sources":["../../model/sourceType.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,UAAU,GAClB,aAAa,GACb,UAAU,GACV,eAAe,GACf,KAAK,GACL,QAAQ,GACR,mBAAmB,GACnB,MAAM,CAAC"}
+{"version":3,"file":"sourceType.d.ts","sourceRoot":"","sources":["../../model/sourceType.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,UAAU,GAClB,aAAa,GACb,UAAU,GACV,eAAe,GACf,KAAK,GACL,QAAQ,GACR,mBAAmB,GACnB,MAAM,GACN,MAAM,GACN,SAAS,CAAC"}

package/dist/model/sourceUpdate.d.ts

@@ -1,9 +1,12 @@
 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/dist/model/sourceUpdate.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sourceUpdate.d.ts","sourceRoot":"","sources":["../../model/sourceUpdate.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAE7D,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,KAAK,CAAC,EAAE,iBAAiB,CAAC;IAE1B;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B,CAAC"}
+{"version":3,"file":"sourceUpdate.d.ts","sourceRoot":"","sources":["../../model/sourceUpdate.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAE7D,MAAM,MAAM,YAAY,GAAG;IACzB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,KAAK,CAAC,EAAE,iBAAiB,CAAC;IAE1B;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B,CAAC"}

package/dist/model/sourceUpdateCommercetools.d.ts

@@ -1,16 +1,13 @@
 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;
     customFields?: CommercetoolsCustomFields;

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

@@ -1 +1 @@
-{"version":3,"file":"sourceUpdateCommercetools.d.ts","sourceRoot":"","sources":["../../model/sourceUpdateCommercetools.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAE7E,MAAM,MAAM,yBAAyB,GAAG;IACtC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IAEnB,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;IAEjC,YAAY,CAAC,EAAE,yBAAyB,CAAC;CAC1C,CAAC"}
+{"version":3,"file":"sourceUpdateCommercetools.d.ts","sourceRoot":"","sources":["../../model/sourceUpdateCommercetools.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAE7E,MAAM,MAAM,yBAAyB,GAAG;IACtC,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IAEnB,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;IAEjC,YAAY,CAAC,EAAE,yBAAyB,CAAC;CAC1C,CAAC"}

package/dist/model/sourceUpdateDocker.d.ts

@@ -2,15 +2,15 @@ import type { DockerRegistry } from './dockerRegistry';
 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/dist/model/sourceUpdateResponse.d.ts

@@ -1,11 +1,14 @@
 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/dist/model/sourceUpdateResponse.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sourceUpdateResponse.d.ts","sourceRoot":"","sources":["../../model/sourceUpdateResponse.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,oBAAoB,GAAG;IACjC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC"}
+{"version":3,"file":"sourceUpdateResponse.d.ts","sourceRoot":"","sources":["../../model/sourceUpdateResponse.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,oBAAoB,GAAG;IACjC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC"}

package/dist/model/streamingTrigger.d.ts

@@ -1,6 +1,6 @@
 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/dist/model/streamingTriggerType.d.ts

@@ -1,5 +1,5 @@
 /**
- * A task that runs continuously.
+ * Task runs continuously.
  */
 export type StreamingTriggerType = 'streaming';
 //# sourceMappingURL=streamingTriggerType.d.ts.map

package/dist/model/streamingUtilsInput.d.ts

@@ -1,6 +1,6 @@
 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/dist/model/subscriptionTrigger.d.ts

@@ -1,6 +1,6 @@
 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/dist/model/subscriptionTriggerType.d.ts

@@ -1,5 +1,5 @@
 /**
- * A task which is triggered by an external subscription (e.g. Webhook).
+ * Task runs after receiving subscribed event.
  */
 export type SubscriptionTriggerType = 'subscription';
 //# sourceMappingURL=subscriptionTriggerType.d.ts.map

package/dist/model/task.d.ts

@@ -3,34 +3,34 @@ import type { TaskInput } from './taskInput';
 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;
     trigger: Trigger;
     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/dist/model/taskCreate.d.ts

@@ -2,25 +2,25 @@ import type { ActionType } from './actionType';
 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;
     trigger: TaskCreateTrigger;
     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;
     input?: TaskInput;

package/dist/model/taskCreateResponse.d.ts

@@ -1,13 +1,13 @@
 /**
- * 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/dist/model/taskInput.d.ts

@@ -1,5 +1,8 @@
 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 | StreamingUtilsInput;
 //# sourceMappingURL=taskInput.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"taskInput.d.ts","sourceRoot":"","sources":["../../model/taskInput.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AACvE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AACvE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAEjE,MAAM,MAAM,SAAS,GACjB,sBAAsB,GACtB,sBAAsB,GACtB,mBAAmB,CAAC"}
+{"version":3,"file":"taskInput.d.ts","sourceRoot":"","sources":["../../model/taskInput.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AACvE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AACvE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAEjE;;GAEG;AACH,MAAM,MAAM,SAAS,GACjB,sBAAsB,GACtB,sBAAsB,GACtB,mBAAmB,CAAC"}

package/dist/model/taskSortKeys.d.ts

@@ -1,5 +1,5 @@
 /**
- * Used to sort the Task list endpoint.
+ * Property by which to sort the list of tasks.
  */
 export type TaskSortKeys = 'action' | 'createdAt' | 'enabled' | 'triggerType' | 'updatedAt';
 //# sourceMappingURL=taskSortKeys.d.ts.map

package/dist/model/taskUpdate.d.ts

@@ -1,21 +1,21 @@
 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;
     trigger?: TriggerUpdateInput;
     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/dist/model/taskUpdateResponse.d.ts

@@ -1,13 +1,13 @@
 /**
- * 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/dist/model/trigger.d.ts

@@ -2,5 +2,8 @@ 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;
 //# sourceMappingURL=trigger.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"trigger.d.ts","sourceRoot":"","sources":["../../model/trigger.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAEjE,MAAM,MAAM,OAAO,GACf,eAAe,GACf,eAAe,GACf,gBAAgB,GAChB,mBAAmB,CAAC"}
+{"version":3,"file":"trigger.d.ts","sourceRoot":"","sources":["../../model/trigger.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAEjE;;GAEG;AACH,MAAM,MAAM,OAAO,GACf,eAAe,GACf,eAAe,GACf,gBAAgB,GAChB,mBAAmB,CAAC"}

package/dist/model/triggerType.d.ts

@@ -1,5 +1,5 @@
 /**
- * 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' | 'schedule' | 'streaming' | 'subscription';
 //# sourceMappingURL=triggerType.d.ts.map

package/dist/model/triggerUpdateInput.d.ts

@@ -1,9 +1,9 @@
 /**
- * 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/dist/model/window.d.ts

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