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

package/dist/model/event.d.ts

@@ -5,11 +5,11 @@ import type { EventType } from './eventType';
  */
 export type Event = {
     /**
-     * The event UUID.
+     * Universally unique identifier (UUID) of an event.
      */
     eventID: string;
     /**
-     * The run UUID.
+     * Universally unique identifier (UUID) of a task run.
      */
     runID: string;
     /**
@@ -24,7 +24,7 @@ export type Event = {
     batchSize: number;
     data?: Record<string, any>;
     /**
-     * Date of publish (RFC3339 format).
+     * Date of publish RFC3339 format.
      */
     publishedAt: string;
 };

package/dist/model/eventSortKeys.d.ts

@@ -1,5 +1,5 @@
 /**
- * Used to sort the Event list endpoint.
+ * Property by which to sort the list of task run events.
  */
 export type EventSortKeys = 'publishedAt' | 'status' | 'type';
 //# sourceMappingURL=eventSortKeys.d.ts.map

package/dist/model/index.d.ts

@@ -50,6 +50,7 @@ export * from './listEventsResponse';
 export * from './listSourcesResponse';
 export * from './listTasksResponse';
 export * from './mappingFieldDirective';
+export * from './mappingFormatSchema';
 export * from './mappingInput';
 export * from './mappingKitAction';
 export * from './mappingTypeCSV';

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../model/index.ts"],"names":[],"mappings":"AAEA,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC;AAC7B,cAAc,qBAAqB,CAAC;AACpC,cAAc,eAAe,CAAC;AAC9B,cAAc,sBAAsB,CAAC;AACrC,cAAc,aAAa,CAAC;AAC5B,cAAc,oBAAoB,CAAC;AACnC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,mCAAmC,CAAC;AAClD,cAAc,aAAa,CAAC;AAC5B,cAAc,oBAAoB,CAAC;AACnC,cAAc,aAAa,CAAC;AAC5B,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,wBAAwB,CAAC;AACvC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,wBAAwB,CAAC;AACvC,cAAc,0BAA0B,CAAC;AACzC,cAAc,sBAAsB,CAAC;AACrC,cAAc,wBAAwB,CAAC;AACvC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,sBAAsB,CAAC;AACrC,cAAc,wBAAwB,CAAC;AACvC,cAAc,oBAAoB,CAAC;AACnC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,kBAAkB,CAAC;AACjC,cAAc,eAAe,CAAC;AAC9B,cAAc,qBAAqB,CAAC;AACpC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,wBAAwB,CAAC;AACvC,cAAc,0BAA0B,CAAC;AACzC,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC;AACpC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,mBAAmB,CAAC;AAClC,cAAc,kBAAkB,CAAC;AACjC,cAAc,wBAAwB,CAAC;AACvC,cAAc,uBAAuB,CAAC;AACtC,cAAc,aAAa,CAAC;AAC5B,cAAc,SAAS,CAAC;AACxB,cAAc,iBAAiB,CAAC;AAChC,cAAc,eAAe,CAAC;AAC9B,cAAc,aAAa,CAAC;AAC5B,cAAc,+BAA+B,CAAC;AAC9C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,qBAAqB,CAAC;AACpC,cAAc,yBAAyB,CAAC;AACxC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,cAAc,CAAC;AAC7B,cAAc,0BAA0B,CAAC;AACzC,cAAc,mBAAmB,CAAC;AAClC,cAAc,wBAAwB,CAAC;AACvC,cAAc,uBAAuB,CAAC;AACtC,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC;AAC7B,cAAc,YAAY,CAAC;AAC3B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,oBAAoB,CAAC;AACnC,cAAc,cAAc,CAAC;AAC7B,cAAc,OAAO,CAAC;AACtB,cAAc,mBAAmB,CAAC;AAClC,cAAc,cAAc,CAAC;AAC7B,cAAc,eAAe,CAAC;AAC9B,cAAc,iBAAiB,CAAC;AAChC,cAAc,eAAe,CAAC;AAC9B,cAAc,eAAe,CAAC;AAC9B,cAAc,aAAa,CAAC;AAC5B,cAAc,WAAW,CAAC;AAC1B,cAAc,0BAA0B,CAAC;AACzC,cAAc,mBAAmB,CAAC;AAClC,cAAc,wBAAwB,CAAC;AACvC,cAAc,uBAAuB,CAAC;AACtC,cAAc,UAAU,CAAC;AACzB,cAAc,qBAAqB,CAAC;AACpC,cAAc,kBAAkB,CAAC;AACjC,cAAc,aAAa,CAAC;AAC5B,cAAc,uBAAuB,CAAC;AACtC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,wBAAwB,CAAC;AACvC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,2BAA2B,CAAC;AAC1C,cAAc,eAAe,CAAC;AAC9B,cAAc,cAAc,CAAC;AAC7B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,kBAAkB,CAAC;AACjC,cAAc,cAAc,CAAC;AAC7B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,6BAA6B,CAAC;AAC5C,cAAc,sBAAsB,CAAC;AACrC,cAAc,qBAAqB,CAAC;AACpC,cAAc,wBAAwB,CAAC;AACvC,cAAc,oBAAoB,CAAC;AACnC,cAAc,wBAAwB,CAAC;AACvC,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC;AACtC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,QAAQ,CAAC;AACvB,cAAc,cAAc,CAAC;AAC7B,cAAc,sBAAsB,CAAC;AACrC,cAAc,qBAAqB,CAAC;AACpC,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC;AAC7B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,cAAc,CAAC;AAC7B,cAAc,sBAAsB,CAAC;AACrC,cAAc,WAAW,CAAC;AAC1B,cAAc,eAAe,CAAC;AAC9B,cAAc,sBAAsB,CAAC;AACrC,cAAc,UAAU,CAAC;AACzB,cAAc,qBAAqB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../model/index.ts"],"names":[],"mappings":"AAEA,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC;AAC7B,cAAc,qBAAqB,CAAC;AACpC,cAAc,eAAe,CAAC;AAC9B,cAAc,sBAAsB,CAAC;AACrC,cAAc,aAAa,CAAC;AAC5B,cAAc,oBAAoB,CAAC;AACnC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,mCAAmC,CAAC;AAClD,cAAc,aAAa,CAAC;AAC5B,cAAc,oBAAoB,CAAC;AACnC,cAAc,aAAa,CAAC;AAC5B,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,wBAAwB,CAAC;AACvC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,wBAAwB,CAAC;AACvC,cAAc,0BAA0B,CAAC;AACzC,cAAc,sBAAsB,CAAC;AACrC,cAAc,wBAAwB,CAAC;AACvC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,sBAAsB,CAAC;AACrC,cAAc,wBAAwB,CAAC;AACvC,cAAc,oBAAoB,CAAC;AACnC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,kBAAkB,CAAC;AACjC,cAAc,eAAe,CAAC;AAC9B,cAAc,qBAAqB,CAAC;AACpC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,wBAAwB,CAAC;AACvC,cAAc,0BAA0B,CAAC;AACzC,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC;AACpC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,mBAAmB,CAAC;AAClC,cAAc,kBAAkB,CAAC;AACjC,cAAc,wBAAwB,CAAC;AACvC,cAAc,uBAAuB,CAAC;AACtC,cAAc,aAAa,CAAC;AAC5B,cAAc,SAAS,CAAC;AACxB,cAAc,iBAAiB,CAAC;AAChC,cAAc,eAAe,CAAC;AAC9B,cAAc,aAAa,CAAC;AAC5B,cAAc,+BAA+B,CAAC;AAC9C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,qBAAqB,CAAC;AACpC,cAAc,yBAAyB,CAAC;AACxC,cAAc,uBAAuB,CAAC;AACtC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,cAAc,CAAC;AAC7B,cAAc,0BAA0B,CAAC;AACzC,cAAc,mBAAmB,CAAC;AAClC,cAAc,wBAAwB,CAAC;AACvC,cAAc,uBAAuB,CAAC;AACtC,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC;AAC7B,cAAc,YAAY,CAAC;AAC3B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,oBAAoB,CAAC;AACnC,cAAc,cAAc,CAAC;AAC7B,cAAc,OAAO,CAAC;AACtB,cAAc,mBAAmB,CAAC;AAClC,cAAc,cAAc,CAAC;AAC7B,cAAc,eAAe,CAAC;AAC9B,cAAc,iBAAiB,CAAC;AAChC,cAAc,eAAe,CAAC;AAC9B,cAAc,eAAe,CAAC;AAC9B,cAAc,aAAa,CAAC;AAC5B,cAAc,WAAW,CAAC;AAC1B,cAAc,0BAA0B,CAAC;AACzC,cAAc,mBAAmB,CAAC;AAClC,cAAc,wBAAwB,CAAC;AACvC,cAAc,uBAAuB,CAAC;AACtC,cAAc,UAAU,CAAC;AACzB,cAAc,qBAAqB,CAAC;AACpC,cAAc,kBAAkB,CAAC;AACjC,cAAc,aAAa,CAAC;AAC5B,cAAc,uBAAuB,CAAC;AACtC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,wBAAwB,CAAC;AACvC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,2BAA2B,CAAC;AAC1C,cAAc,eAAe,CAAC;AAC9B,cAAc,cAAc,CAAC;AAC7B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,kBAAkB,CAAC;AACjC,cAAc,cAAc,CAAC;AAC7B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,6BAA6B,CAAC;AAC5C,cAAc,sBAAsB,CAAC;AACrC,cAAc,qBAAqB,CAAC;AACpC,cAAc,wBAAwB,CAAC;AACvC,cAAc,oBAAoB,CAAC;AACnC,cAAc,wBAAwB,CAAC;AACvC,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC;AACtC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,QAAQ,CAAC;AACvB,cAAc,cAAc,CAAC;AAC7B,cAAc,sBAAsB,CAAC;AACrC,cAAc,qBAAqB,CAAC;AACpC,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC;AAC7B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,cAAc,CAAC;AAC7B,cAAc,sBAAsB,CAAC;AACrC,cAAc,WAAW,CAAC;AAC1B,cAAc,eAAe,CAAC;AAC9B,cAAc,sBAAsB,CAAC;AACrC,cAAc,UAAU,CAAC;AACzB,cAAc,qBAAqB,CAAC"}

package/dist/model/listTasksResponse.d.ts

@@ -1,7 +1,7 @@
 import type { Pagination } from './pagination';
 import type { Task } from './task';
 /**
- * A list of tasks with pagination details.
+ * Configured tasks and pagination information.
  */
 export type ListTasksResponse = {
     tasks: Task[];

package/dist/model/mappingFormatSchema.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Mapping format schema.
+ */
+export type MappingFormatSchema = 'mappingkit/v1';
+//# sourceMappingURL=mappingFormatSchema.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"mappingFormatSchema.d.ts","sourceRoot":"","sources":["../../model/mappingFormatSchema.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,eAAe,CAAC"}

package/dist/model/mappingInput.d.ts

@@ -1,12 +1,10 @@
+import type { MappingFormatSchema } from './mappingFormatSchema';
 import type { MappingKitAction } from './mappingKitAction';
 /**
- * Transformations to apply to source, serialized as a JSON string.
+ * Transformations to apply to the source, serialized as a JSON string.
  */
 export type MappingInput = {
-    /**
-     * Name of the mapping format schema, `mappingkit/v1` is currently the only supported format.
-     */
-    format: string;
+    format: MappingFormatSchema;
     actions: MappingKitAction[];
 };
 //# sourceMappingURL=mappingInput.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"mappingInput.d.ts","sourceRoot":"","sources":["../../model/mappingInput.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAE3D;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf,OAAO,EAAE,gBAAgB,EAAE,CAAC;CAC7B,CAAC"}
+{"version":3,"file":"mappingInput.d.ts","sourceRoot":"","sources":["../../model/mappingInput.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AACjE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAE3D;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,MAAM,EAAE,mBAAmB,CAAC;IAE5B,OAAO,EAAE,gBAAgB,EAAE,CAAC;CAC7B,CAAC"}

package/dist/model/methodType.d.ts

@@ -1,2 +1,5 @@
+/**
+ * HTTP method to be used for retrieving your data.
+ */
 export type MethodType = 'GET' | 'POST';
 //# sourceMappingURL=methodType.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"methodType.d.ts","sourceRoot":"","sources":["../../model/methodType.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,UAAU,GAAG,KAAK,GAAG,MAAM,CAAC"}
+{"version":3,"file":"methodType.d.ts","sourceRoot":"","sources":["../../model/methodType.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,KAAK,GAAG,MAAM,CAAC"}

package/dist/model/onDemandDateUtilsInput.d.ts

@@ -1,14 +1,14 @@
 import type { MappingInput } from './mappingInput';
 /**
- * The input for an `onDemand` task whose source is of type `bigquery` and for which extracted data spans a given time range.
+ * 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 = {
     /**
-     * The start date of the extraction (RFC3339 format).
+     * Earliest date in RFC3339 format of the extracted data from Big Query.
      */
     startDate: string;
     /**
-     * The end date of the extraction (RFC3339 format).
+     * Latest date in RFC3339 format of the extracted data from Big Query.
      */
     endDate: string;
     mapping?: MappingInput;

package/dist/model/onDemandTrigger.d.ts

@@ -1,11 +1,11 @@
 import type { OnDemandTriggerType } from './onDemandTriggerType';
 /**
- * The trigger information of a task of type `onDemand`.
+ * Trigger information for manually-triggered tasks.
  */
 export type OnDemandTrigger = {
     type: OnDemandTriggerType;
     /**
-     * The last time the scheduled task ran (RFC3339 format).
+     * The last time the scheduled task ran in RFC3339 format.
      */
     lastRun?: string;
 };

package/dist/model/onDemandTriggerInput.d.ts

@@ -1,6 +1,6 @@
 import type { OnDemandTriggerType } from './onDemandTriggerType';
 /**
- * The trigger information of a task of type `onDemand`.
+ * Trigger information for manually-triggered tasks.
  */
 export type OnDemandTriggerInput = {
     type: OnDemandTriggerType;

package/dist/model/onDemandTriggerType.d.ts

@@ -1,5 +1,5 @@
 /**
- * A task which is manually executed via the run task endpoint.
+ * Task is run manually, with the `/run` endpoint.
  */
 export type OnDemandTriggerType = 'onDemand';
 //# sourceMappingURL=onDemandTriggerType.d.ts.map

package/dist/model/orderKeys.d.ts

@@ -1,5 +1,5 @@
 /**
- * Used to order a sorted request.
+ * Ascending or descending sort order.
  */
 export type OrderKeys = 'asc' | 'desc';
 //# sourceMappingURL=orderKeys.d.ts.map

package/dist/model/pagination.d.ts

@@ -1,7 +1,22 @@
+/**
+ * Paginated API response.
+ */
 export type Pagination = {
+    /**
+     * Number of pages in the API response.
+     */
     nbPages: number;
+    /**
+     * Page of the API response to retrieve.
+     */
     page: number;
+    /**
+     * Number of items in the API response.
+     */
     nbItems: number;
+    /**
+     * Number of items per page.
+     */
     itemsPerPage: number;
 };
 //# sourceMappingURL=pagination.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"pagination.d.ts","sourceRoot":"","sources":["../../model/pagination.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,UAAU,GAAG;IACvB,OAAO,EAAE,MAAM,CAAC;IAEhB,IAAI,EAAE,MAAM,CAAC;IAEb,OAAO,EAAE,MAAM,CAAC;IAEhB,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC"}
+{"version":3,"file":"pagination.d.ts","sourceRoot":"","sources":["../../model/pagination.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC"}

package/dist/model/platform.d.ts

@@ -1,5 +1,5 @@
 /**
- * Describe which platform the Authentication is used for.
+ * Name of an ecommerce platform with which to authenticate. This determines which authentication type you can select.
  */
-export type Platform = 'bigcommerce' | 'commercetools';
+export type Platform = 'bigcommerce' | 'commercetools' | 'shopify';
 //# sourceMappingURL=platform.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"platform.d.ts","sourceRoot":"","sources":["../../model/platform.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,aAAa,GAAG,eAAe,CAAC"}
+{"version":3,"file":"platform.d.ts","sourceRoot":"","sources":["../../model/platform.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,aAAa,GAAG,eAAe,GAAG,SAAS,CAAC"}

package/dist/model/platformNone.d.ts

@@ -1,5 +1,5 @@
 /**
- * Used to filter Authentication without platform property.
+ * Authentication resource not tied to any ecommerce platform, used for filtering.
  */
 export type PlatformNone = 'none';
 //# sourceMappingURL=platformNone.d.ts.map

package/dist/model/recordType.d.ts

@@ -1,5 +1,5 @@
 /**
- * Determines the indexing strategy to use for a given e-commerce source.
+ * Record type for ecommerce sources.
  */
 export type RecordType = 'product' | 'variant';
 //# sourceMappingURL=recordType.d.ts.map

package/dist/model/run.d.ts

@@ -5,37 +5,37 @@ import type { RunStatus } from './runStatus';
 import type { RunType } from './runType';
 export type Run = {
     /**
-     * The run UUID.
+     * Universally unique identifier (UUID) of a task run.
      */
     runID: string;
     appID: string;
     /**
-     * The task UUID.
+     * Universally unique identifier (UUID) of a task.
      */
     taskID: string;
     status: RunStatus;
     progress?: RunProgress;
     outcome?: RunOutcome;
     /**
-     * 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;
     /**
-     * Explains the result of outcome.
+     * More information about the task run\'s outcome.
      */
     reason?: string;
     reasonCode?: RunReasonCode;
     type: RunType;
     /**
-     * Date of creation (RFC3339 format).
+     * Date of creation in RFC3339 format.
      */
     createdAt: string;
     /**
-     * Date of start (RFC3339 format).
+     * Date of start in RFC3339 format.
      */
     startedAt?: string;
     /**
-     * Date of finish (RFC3339 format).
+     * Date of finish in RFC3339 format.
      */
     finishedAt?: string;
 };

package/dist/model/runOutcome.d.ts

@@ -1,2 +1,5 @@
+/**
+ * Task run outcome.
+ */
 export type RunOutcome = 'failure' | 'processing' | 'success';
 //# sourceMappingURL=runOutcome.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"runOutcome.d.ts","sourceRoot":"","sources":["../../model/runOutcome.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,UAAU,GAAG,SAAS,GAAG,YAAY,GAAG,SAAS,CAAC"}
+{"version":3,"file":"runOutcome.d.ts","sourceRoot":"","sources":["../../model/runOutcome.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,SAAS,GAAG,YAAY,GAAG,SAAS,CAAC"}

package/dist/model/runReasonCode.d.ts

@@ -1,5 +1,5 @@
 /**
- * An identifier that pairs with the outcome reason.
+ * A code for the task run\'s outcome. A readable description of the code is included in the `reason` response property.
  */
 export type RunReasonCode = 'blocking' | 'critical' | 'discarded' | 'internal' | 'no_events' | 'ok' | 'too_many_errors';
 //# sourceMappingURL=runReasonCode.d.ts.map

package/dist/model/runResponse.d.ts

@@ -1,13 +1,13 @@
 /**
- * The response from the run task API, containing an Observability Run ID and the time it was created at.
+ * API response for running a task.
  */
 export type RunResponse = {
     /**
-     * The run UUID.
+     * Universally unique identifier (UUID) of a task run.
      */
     runID: string;
     /**
-     * Date of creation (RFC3339 format).
+     * Date of creation in RFC3339 format.
      */
     createdAt: string;
 };

package/dist/model/runSortKeys.d.ts

@@ -1,5 +1,5 @@
 /**
- * Used to sort the Run list endpoint.
+ * Property by which to sort the list of task runs.
  */
 export type RunSortKeys = 'createdAt' | 'status' | 'updatedAt';
 //# sourceMappingURL=runSortKeys.d.ts.map

package/dist/model/runStatus.d.ts

@@ -1,2 +1,5 @@
+/**
+ * Task run status.
+ */
 export type RunStatus = 'created' | 'finished' | 'idled' | 'skipped' | 'started';
 //# sourceMappingURL=runStatus.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"runStatus.d.ts","sourceRoot":"","sources":["../../model/runStatus.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,SAAS,GACjB,SAAS,GACT,UAAU,GACV,OAAO,GACP,SAAS,GACT,SAAS,CAAC"}
+{"version":3,"file":"runStatus.d.ts","sourceRoot":"","sources":["../../model/runStatus.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,SAAS,GACjB,SAAS,GACT,UAAU,GACV,OAAO,GACP,SAAS,GACT,SAAS,CAAC"}

package/dist/model/runType.d.ts

@@ -1,2 +1,5 @@
+/**
+ * Task run type.
+ */
 export type RunType = 'discover' | 'reindex' | 'update';
 //# sourceMappingURL=runType.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"runType.d.ts","sourceRoot":"","sources":["../../model/runType.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,OAAO,GAAG,UAAU,GAAG,SAAS,GAAG,QAAQ,CAAC"}
+{"version":3,"file":"runType.d.ts","sourceRoot":"","sources":["../../model/runType.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG,UAAU,GAAG,SAAS,GAAG,QAAQ,CAAC"}

package/dist/model/scheduleDateUtilsInput.d.ts

@@ -1,10 +1,10 @@
 import type { MappingInput } from './mappingInput';
 /**
- * The input for a `schedule` task whose source is of type `bigquery` and for which extracted data spans a fixed number of days.
+ * Input for scheduled tasks whose source is of type `bigquery` and for which extracted data spans a fixed number of days.
  */
 export type ScheduleDateUtilsInput = {
     /**
-     * The timeframe of the extraction, in number of days from today.
+     * Number of days in the past until the current day for which to extract Big Query data.
      */
     timeframe: number;
     mapping?: MappingInput;

package/dist/model/scheduleTrigger.d.ts

@@ -1,19 +1,19 @@
 import type { ScheduleTriggerType } from './scheduleTriggerType';
 /**
- * The trigger information for a task of type \'schedule\'.
+ * Trigger information for scheduled tasks.
  */
 export type ScheduleTrigger = {
     type: ScheduleTriggerType;
     /**
-     * A cron expression that represent at which regularity the task should run.
+     * Cron expression for the task\'s schedule.
      */
     cron: string;
     /**
-     * The last time the scheduled task ran (RFC3339 format).
+     * The last time the scheduled task ran in RFC3339 format.
      */
     lastRun?: string;
     /**
-     * The next scheduled run of the task (RFC3339 format).
+     * The next scheduled run of the task in RFC3339 format.
      */
     nextRun: string;
 };

package/dist/model/scheduleTriggerInput.d.ts

@@ -1,11 +1,11 @@
 import type { ScheduleTriggerType } from './scheduleTriggerType';
 /**
- * The trigger input for a task of type \'schedule\'.
+ * Trigger input for scheduled tasks.
  */
 export type ScheduleTriggerInput = {
     type: ScheduleTriggerType;
     /**
-     * A cron expression that represent at which regularity the task should run.
+     * Cron expression for the task\'s schedule.
      */
     cron: string;
 };

package/dist/model/scheduleTriggerType.d.ts

@@ -1,5 +1,5 @@
 /**
- * A task which is triggered by a schedule (cron expression).
+ * Task runs on a schedule.
  */
 export type ScheduleTriggerType = 'schedule';
 //# sourceMappingURL=scheduleTriggerType.d.ts.map

package/dist/model/source.d.ts

@@ -2,22 +2,22 @@ import type { SourceInput } from './sourceInput';
 import type { SourceType } from './sourceType';
 export type Source = {
     /**
-     * The source UUID.
+     * Universally uniqud identifier (UUID) of a source.
      */
     sourceID: string;
     type: SourceType;
     name: string;
     input: SourceInput;
     /**
-     * The authentication UUID.
+     * Universally unique identifier (UUID) of an authentication resource.
      */
     authenticationID?: string;
     /**
-     * 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/sourceBigCommerce.d.ts

@@ -2,7 +2,7 @@ import type { BigCommerceChannel } from './bigCommerceChannel';
 import type { BigCommerceMetafield } from './bigCommerceMetafield';
 export type SourceBigCommerce = {
     /**
-     * The store hash identifying the store the shopper is signing in to.
+     * Store hash identifying your BigCommerce store.
      */
     storeHash: string;
     channel?: BigCommerceChannel;

package/dist/model/sourceBigQuery.d.ts

@@ -1,20 +1,20 @@
 import type { BigQueryDataType } from './bigQueryDataType';
 export type SourceBigQuery = {
     /**
-     * Project ID of the BigQuery Source.
+     * Project ID of the BigQuery source.
      */
     projectID: string;
     /**
-     * Dataset ID of the BigQuery Source.
+     * Dataset ID of the BigQuery source.
      */
     datasetID: string;
     dataType?: BigQueryDataType;
     /**
-     * Table name (for default BQ).
+     * Table name for the BigQuery export.
      */
     table?: string;
     /**
-     * Table prefix (for Google Analytics).
+     * Table prefix for a Google Analytics 4 data export to BigQuery.
      */
     tablePrefix?: string;
     /**
@@ -22,7 +22,7 @@ export type SourceBigQuery = {
      */
     customSQLRequest?: string;
     /**
-     * The name of the column that contains the unique ID, used as `objectID` in Algolia.
+     * Name of a column that contains a unique ID which will be used as `objectID` in Algolia.
      */
     uniqueIDColumn?: string;
 };

package/dist/model/sourceCSV.d.ts

@@ -2,15 +2,15 @@ import type { MappingTypeCSV } from './mappingTypeCSV';
 import type { MethodType } from './methodType';
 export type SourceCSV = {
     /**
-     * The URL of the file.
+     * URL of the file.
      */
     url: string;
     /**
-     * The name of the column that contains the unique ID, used as `objectID` in Algolia.
+     * Name of a column that contains a unique ID which will be used as `objectID` in Algolia.
      */
     uniqueIDColumn?: string;
     /**
-     * Mapping of type for every column. For example {\"myColumn\": \"boolean\", \"myOtherColumn\": \"json\"}.
+     * Key-value pairs of column names and their expected types.
      */
     mapping?: Record<string, MappingTypeCSV>;
     method?: MethodType;

package/dist/model/sourceCommercetools.d.ts

@@ -2,13 +2,13 @@ import type { CommercetoolsCustomFields } from './commercetoolsCustomFields';
 export type SourceCommercetools = {
     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;
     projectKey: 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/sourceCreate.d.ts

@@ -2,10 +2,13 @@ import type { SourceInput } from './sourceInput';
 import type { SourceType } from './sourceType';
 export type SourceCreate = {
     type: SourceType;
+    /**
+     * Descriptive name of the source.
+     */
     name: string;
     input: SourceInput;
     /**
-     * The authentication UUID.
+     * Universally unique identifier (UUID) of an authentication resource.
      */
     authenticationID?: string;
 };

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

@@ -1 +1 @@
-{"version":3,"file":"sourceCreate.d.ts","sourceRoot":"","sources":["../../model/sourceCreate.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,UAAU,CAAC;IAEjB,IAAI,EAAE,MAAM,CAAC;IAEb,KAAK,EAAE,WAAW,CAAC;IAEnB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B,CAAC"}
+{"version":3,"file":"sourceCreate.d.ts","sourceRoot":"","sources":["../../model/sourceCreate.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,UAAU,CAAC;IAEjB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb,KAAK,EAAE,WAAW,CAAC;IAEnB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B,CAAC"}

package/dist/model/sourceCreateResponse.d.ts

@@ -1,11 +1,14 @@
 export type SourceCreateResponse = {
     /**
-     * The source UUID.
+     * Universally uniqud identifier (UUID) of a source.
      */
     sourceID: string;
+    /**
+     * Descriptive name of the source.
+     */
     name: string;
     /**
-     * Date of creation (RFC3339 format).
+     * Date of creation in RFC3339 format.
      */
     createdAt: string;
 };

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

@@ -1 +1 @@
-{"version":3,"file":"sourceCreateResponse.d.ts","sourceRoot":"","sources":["../../model/sourceCreateResponse.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":"sourceCreateResponse.d.ts","sourceRoot":"","sources":["../../model/sourceCreateResponse.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/sourceDocker.d.ts

@@ -4,15 +4,15 @@ export type SourceDocker = {
     imageType: DockerImageType;
     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/sourceGA4BigQueryExport.d.ts

@@ -1,14 +1,14 @@
 export type SourceGA4BigQueryExport = {
     /**
-     * GCP project ID that the BigQuery Export writes to.
+     * GCP project ID that the BigQuery export writes to.
      */
     projectID: string;
     /**
-     * BigQuery dataset ID that the BigQuery Export writes to.
+     * BigQuery dataset ID that the BigQuery export writes to.
      */
     datasetID: string;
     /**
-     * Prefix of the tables that the BigQuery Export writes to (i.e. Events_intraday_ for streaming, events_ for daily).
+     * Prefix of the tables that the BigQuery Export writes to.
      */
     tablePrefix: string;
 };

package/dist/model/sourceJSON.d.ts

@@ -1,11 +1,11 @@
 import type { MethodType } from './methodType';
 export type SourceJSON = {
     /**
-     * The URL of the file.
+     * URL of the file.
      */
     url: string;
     /**
-     * The name of the column that contains the unique ID, used as `objectID` in Algolia.
+     * Name of a column that contains a unique ID which will be used as `objectID` in Algolia.
      */
     uniqueIDColumn?: string;
     method?: MethodType;

package/dist/model/sourceSortKeys.d.ts

@@ -1,5 +1,5 @@
 /**
- * Used to sort the Source list endpoint.
+ * Property by which to sort the list of sources.
  */
 export type SourceSortKeys = 'createdAt' | 'name' | 'type' | 'updatedAt';
 //# sourceMappingURL=sourceSortKeys.d.ts.map