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

package/model/dockerSourceDiscover.ts

@@ -2,12 +2,12 @@
 
 export type DockerSourceDiscover = {
   /**
-   * 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/model/event.ts

@@ -8,12 +8,12 @@ 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;
 
@@ -34,7 +34,7 @@ export type Event = {
   data?: Record<string, any>;
 
   /**
-   * Date of publish (RFC3339 format).
+   * Date of publish RFC3339 format.
    */
   publishedAt: string;
 };

package/model/eventSortKeys.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.
 
 /**
- * Used to sort the Event list endpoint.
+ * Property by which to sort the list of task run events.
  */
 export type EventSortKeys = 'publishedAt' | 'status' | 'type';

package/model/index.ts

@@ -52,6 +52,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/model/listTasksResponse.ts

@@ -4,7 +4,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/model/mappingFormatSchema.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.
+
+/**
+ * Mapping format schema.
+ */
+export type MappingFormatSchema = 'mappingkit/v1';

package/model/mappingInput.ts

@@ -1,15 +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.
 
+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[];
 };

package/model/methodType.ts

@@ -1,3 +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.
 
+/**
+ * HTTP method to be used for retrieving your data.
+ */
 export type MethodType = 'GET' | 'POST';

package/model/onDemandDateUtilsInput.ts

@@ -3,16 +3,16 @@
 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;
 

package/model/onDemandTrigger.ts

@@ -3,13 +3,13 @@
 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/model/onDemandTriggerInput.ts

@@ -3,7 +3,7 @@
 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/model/onDemandTriggerType.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 manually executed via the run task endpoint.
+ * Task is run manually, with the `/run` endpoint.
  */
 export type OnDemandTriggerType = 'onDemand';

package/model/orderKeys.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.
 
 /**
- * Used to order a sorted request.
+ * Ascending or descending sort order.
  */
 export type OrderKeys = 'asc' | 'desc';

package/model/pagination.ts

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

package/model/platform.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.
 
 /**
- * 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';

package/model/platformNone.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.
 
 /**
- * Used to filter Authentication without platform property.
+ * Authentication resource not tied to any ecommerce platform, used for filtering.
  */
 export type PlatformNone = 'none';

package/model/recordType.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.
 
 /**
- * Determines the indexing strategy to use for a given e-commerce source.
+ * Record type for ecommerce sources.
  */
 export type RecordType = 'product' | 'variant';

package/model/run.ts

@@ -8,14 +8,14 @@ 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;
 
@@ -26,12 +26,12 @@ export type Run = {
   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;
 
@@ -40,17 +40,17 @@ export type Run = {
   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/model/runOutcome.ts

@@ -1,3 +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 run outcome.
+ */
 export type RunOutcome = 'failure' | 'processing' | 'success';

package/model/runReasonCode.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.
 
 /**
- * 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'

package/model/runResponse.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 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/model/runSortKeys.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.
 
 /**
- * Used to sort the Run list endpoint.
+ * Property by which to sort the list of task runs.
  */
 export type RunSortKeys = 'createdAt' | 'status' | 'updatedAt';

package/model/runStatus.ts

@@ -1,5 +1,8 @@
 // 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 run status.
+ */
 export type RunStatus =
   | 'created'
   | 'finished'

package/model/runType.ts

@@ -1,3 +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 run type.
+ */
 export type RunType = 'discover' | 'reindex' | 'update';

package/model/scheduleDateUtilsInput.ts

@@ -3,11 +3,11 @@
 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;
 

package/model/scheduleTrigger.ts

@@ -3,23 +3,23 @@
 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/model/scheduleTriggerInput.ts

@@ -3,13 +3,13 @@
 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/model/scheduleTriggerType.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 a schedule (cron expression).
+ * Task runs on a schedule.
  */
 export type ScheduleTriggerType = 'schedule';

package/model/source.ts

@@ -5,7 +5,7 @@ import type { SourceType } from './sourceType';
 
 export type Source = {
   /**
-   * The source UUID.
+   * Universally uniqud identifier (UUID) of a source.
    */
   sourceID: string;
 
@@ -16,17 +16,17 @@ export type Source = {
   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/model/sourceBigCommerce.ts

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

package/model/sourceBigQuery.ts

@@ -4,24 +4,24 @@ 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;
 
@@ -31,7 +31,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/model/sourceCSV.ts

@@ -5,17 +5,17 @@ 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>;
 

package/model/sourceCommercetools.ts

@@ -6,7 +6,7 @@ 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[];
 
@@ -15,7 +15,7 @@ export type SourceCommercetools = {
   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;
 

package/model/sourceCreate.ts

@@ -6,12 +6,15 @@ 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/model/sourceCreateResponse.ts

@@ -2,14 +2,17 @@
 
 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/model/sourceDocker.ts

@@ -9,17 +9,17 @@ export type SourceDocker = {
   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/sourceGA4BigQueryExport.ts

@@ -2,17 +2,17 @@
 
 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/model/sourceJSON.ts

@@ -4,12 +4,12 @@ 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;
 

package/model/sourceSortKeys.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.
 
 /**
- * Used to sort the Source list endpoint.
+ * Property by which to sort the list of sources.
  */
 export type SourceSortKeys = 'createdAt' | 'name' | 'type' | 'updatedAt';