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

package/model/run.ts

@@ -1,15 +1,22 @@
-// 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 { RunOutcome } from './runOutcome';
 import type { RunProgress } from './runProgress';
+import type { RunReasonCode } from './runReasonCode';
 import type { RunStatus } from './runStatus';
 import type { RunType } from './runType';
 
 export type Run = {
+  /**
+   * Universally unique identifier (UUID) of a task run.
+   */
   runID: string;
 
   appID: string;
 
+  /**
+   * Universally unique identifier (UUID) of a task.
+   */
   taskID: string;
 
   status: RunStatus;
@@ -18,25 +25,32 @@ export type Run = {
 
   outcome?: RunOutcome;
 
-  type: RunType;
+  /**
+   * Maximum accepted percentage of failures for a task run to finish successfully.
+   */
+  failureThreshold?: number;
 
   /**
-   * Date of creation (RFC3339 format).
+   * More information about the task run\'s outcome.
    */
-  createdAt: string;
+  reason?: string;
+
+  reasonCode?: RunReasonCode;
+
+  type: RunType;
 
   /**
-   * Date of last update (RFC3339 format).
+   * Date of creation in RFC 3339 format.
    */
-  updatedAt: string;
+  createdAt: string;
 
   /**
-   * Date of start (RFC3339 format).
+   * Date of start in RFC 3339 format.
    */
   startedAt?: string;
 
   /**
-   * Date of finish (RFC3339 format).
+   * Date of finish in RFC 3339 format.
    */
   finishedAt?: string;
 };

package/model/runListResponse.ts

@@ -1,10 +1,13 @@
-// 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 { Pagination } from './pagination';
 import type { Run } from './run';
+import type { Window } from './window';
 
 export type RunListResponse = {
   runs: Run[];
 
   pagination: Pagination;
+
+  window: Window;
 };

package/model/runOutcome.ts

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

package/model/runProgress.ts

@@ -1,4 +1,4 @@
-// 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 RunProgress = {
   expectedNbOfEvents?: number;

package/model/runReasonCode.ts

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

package/model/runResponse.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 running a task.
+ */
 export type RunResponse = {
+  /**
+   * Universally unique identifier (UUID) of a task run.
+   */
   runID: string;
 
   /**
-   * Date of creation (RFC3339 format).
+   * Date of creation in RFC 3339 format.
    */
   createdAt: string;
 };

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

package/model/runStatus.ts

@@ -1,3 +1,11 @@
-// 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 RunStatus = 'created' | 'finished' | 'started';
+/**
+ * Task run status.
+ */
+export type RunStatus =
+  | 'created'
+  | 'finished'
+  | 'idled'
+  | 'skipped'
+  | 'started';

package/model/runType.ts

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

package/model/scheduleTrigger.ts

@@ -0,0 +1,25 @@
+// 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 { ScheduleTriggerType } from './scheduleTriggerType';
+
+/**
+ * Trigger information for scheduled tasks.
+ */
+export type ScheduleTrigger = {
+  type: ScheduleTriggerType;
+
+  /**
+   * Cron expression for the task\'s schedule.
+   */
+  cron: string;
+
+  /**
+   * The last time the scheduled task ran in RFC 3339 format.
+   */
+  lastRun?: string;
+
+  /**
+   * The next scheduled run of the task in RFC 3339 format.
+   */
+  nextRun: string;
+};

package/model/scheduleTriggerInput.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 { ScheduleTriggerType } from './scheduleTriggerType';
+
+/**
+ * Trigger input for scheduled tasks.
+ */
+export type ScheduleTriggerInput = {
+  type: ScheduleTriggerType;
+
+  /**
+   * Cron expression for the task\'s schedule.
+   */
+  cron: string;
+};

package/model/scheduleTriggerType.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 on a schedule.
+ */
+export type ScheduleTriggerType = 'schedule';

package/model/shopifyInput.ts

@@ -0,0 +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 { ShopifyMarket } from './shopifyMarket';
+import type { ShopifyMetafield } from './shopifyMetafield';
+
+/**
+ * Represents the required elements of the task input when using a `shopify` source.
+ */
+export type ShopifyInput = {
+  metafields: ShopifyMetafield[];
+
+  market: ShopifyMarket;
+};

package/model/shopifyMarket.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.
+
+/**
+ * Represents a market in Shopify.
+ */
+export type ShopifyMarket = {
+  countries: string[];
+
+  currencies: string[];
+
+  locales: string[];
+};

package/model/shopifyMetafield.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.
+
+/**
+ * Represents a metafield in Shopify.
+ */
+export type ShopifyMetafield = {
+  namespace: string;
+
+  key: string;
+
+  value: string;
+};

package/model/sortKeys.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.
+
+/**
+ * Property by which to sort the list.
+ */
+export type SortKeys = 'createdAt' | 'name' | 'type' | 'updatedAt';

package/model/source.ts

@@ -1,9 +1,12 @@
-// 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 { SourceInput } from './sourceInput';
 import type { SourceType } from './sourceType';
 
 export type Source = {
+  /**
+   * Universally uniqud identifier (UUID) of a source.
+   */
   sourceID: string;
 
   type: SourceType;
@@ -12,15 +15,18 @@ export type Source = {
 
   input: SourceInput;
 
+  /**
+   * Universally unique identifier (UUID) of an authentication resource.
+   */
   authenticationID?: string;
 
   /**
-   * Date of creation (RFC3339 format).
+   * Date of creation in RFC 3339 format.
    */
   createdAt: string;
 
   /**
-   * Date of last update (RFC3339 format).
+   * Date of last update in RFC 3339 format.
    */
   updatedAt?: string;
 };

package/model/sourceBigCommerce.ts

@@ -1,5 +1,19 @@
-// 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 { BigCommerceChannel } from './bigCommerceChannel';
+import type { BigCommerceMetafield } from './bigCommerceMetafield';
 
 export type SourceBigCommerce = {
-  storeHash?: string;
+  /**
+   * Store hash identifying your BigCommerce store.
+   */
+  storeHash: string;
+
+  channel?: BigCommerceChannel;
+
+  customFields?: string[];
+
+  productMetafields?: BigCommerceMetafield[];
+
+  variantMetafields?: BigCommerceMetafield[];
 };

package/model/sourceBigQuery.ts

@@ -0,0 +1,37 @@
+// 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 { BigQueryDataType } from './bigQueryDataType';
+
+export type SourceBigQuery = {
+  /**
+   * Project ID of the BigQuery source.
+   */
+  projectID: string;
+
+  /**
+   * Dataset ID of the BigQuery source.
+   */
+  datasetID: string;
+
+  dataType?: BigQueryDataType;
+
+  /**
+   * Table name for the BigQuery export.
+   */
+  table?: string;
+
+  /**
+   * Table prefix for a Google Analytics 4 data export to BigQuery.
+   */
+  tablePrefix?: string;
+
+  /**
+   * Custom SQL request to extract data from the BigQuery table.
+   */
+  customSQLRequest?: string;
+
+  /**
+   * Name of a column that contains a unique ID which will be used as `objectID` in Algolia.
+   */
+  uniqueIDColumn?: string;
+};

package/model/sourceCSV.ts

@@ -0,0 +1,28 @@
+// 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 { MappingTypeCSV } from './mappingTypeCSV';
+import type { MethodType } from './methodType';
+
+export type SourceCSV = {
+  /**
+   * URL of the file.
+   */
+  url: string;
+
+  /**
+   * Name of a column that contains a unique ID which will be used as `objectID` in Algolia.
+   */
+  uniqueIDColumn?: string;
+
+  /**
+   * Key-value pairs of column names and their expected types.
+   */
+  mapping?: Record<string, MappingTypeCSV>;
+
+  method?: MethodType;
+
+  /**
+   * The character used to split the value on each line, default to a comma (\\r, \\n, 0xFFFD, and space are forbidden).
+   */
+  delimiter?: string;
+};

package/model/sourceCommercetools.ts

@@ -1,14 +1,23 @@
-// 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 { 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;
+
+  /**
+   * Whether a fallback value is stored in the Algolia record if there\'s no inventory information about the product.
+   */
+  fallbackIsInStockValue?: boolean;
+
+  customFields?: CommercetoolsCustomFields;
 };

package/model/sourceCreate.ts

@@ -1,4 +1,4 @@
-// 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 { SourceInput } from './sourceInput';
 import type { SourceType } from './sourceType';
@@ -6,9 +6,15 @@ import type { SourceType } from './sourceType';
 export type SourceCreate = {
   type: SourceType;
 
+  /**
+   * Descriptive name of the source.
+   */
   name: string;
 
   input: SourceInput;
 
-  authenticationID: string;
+  /**
+   * Universally unique identifier (UUID) of an authentication resource.
+   */
+  authenticationID?: string;
 };

package/model/sourceCreateResponse.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 SourceCreateResponse = {
+  /**
+   * 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 RFC 3339 format.
    */
   createdAt: string;
 };

package/model/sourceDocker.ts

@@ -0,0 +1,25 @@
+// 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 { DockerImageType } from './dockerImageType';
+import type { DockerRegistry } from './dockerRegistry';
+
+export type SourceDocker = {
+  imageType: DockerImageType;
+
+  registry: DockerRegistry;
+
+  /**
+   * Docker image name.
+   */
+  image: string;
+
+  /**
+   * Docker image version.
+   */
+  version?: string;
+
+  /**
+   * Configuration of the spec.
+   */
+  configuration: Record<string, any>;
+};

package/model/sourceGA4BigQueryExport.ts

@@ -0,0 +1,18 @@
+// 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 SourceGA4BigQueryExport = {
+  /**
+   * GCP project ID that the BigQuery export writes to.
+   */
+  projectID: string;
+
+  /**
+   * BigQuery dataset ID that the BigQuery export writes to.
+   */
+  datasetID: string;
+
+  /**
+   * Prefix of the tables that the BigQuery Export writes to.
+   */
+  tablePrefix: string;
+};

package/model/sourceInput.ts

@@ -1,7 +1,20 @@
-// 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 { SourceBigCommerce } from './sourceBigCommerce';
+import type { SourceBigQuery } from './sourceBigQuery';
+import type { SourceCSV } from './sourceCSV';
 import type { SourceCommercetools } from './sourceCommercetools';
-import type { SourceJson } from './sourceJson';
+import type { SourceDocker } from './sourceDocker';
+import type { SourceGA4BigQueryExport } from './sourceGA4BigQueryExport';
+import type { SourceJSON } from './sourceJSON';
+import type { SourceShopify } from './sourceShopify';
 
-export type SourceInput = SourceBigCommerce | SourceCommercetools | SourceJson;
+export type SourceInput =
+  | SourceBigCommerce
+  | SourceBigQuery
+  | SourceCommercetools
+  | SourceCSV
+  | SourceDocker
+  | SourceGA4BigQueryExport
+  | SourceJSON
+  | SourceShopify;

package/model/sourceJSON.ts

@@ -0,0 +1,17 @@
+// 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 { MethodType } from './methodType';
+
+export type SourceJSON = {
+  /**
+   * URL of the file.
+   */
+  url: string;
+
+  /**
+   * Name of a column that contains a unique ID which will be used as `objectID` in Algolia.
+   */
+  uniqueIDColumn?: string;
+
+  method?: MethodType;
+};

package/model/sourceSearch.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 SourceSearch = {
+  sourceIDs: string[];
+};

package/model/sourceShopify.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.
+
+import type { SourceShopifyBase } from './sourceShopifyBase';
+import type { SourceUpdateShopify } from './sourceUpdateShopify';
+
+export type SourceShopify = SourceShopifyBase & SourceUpdateShopify;

package/model/sourceShopifyBase.ts

@@ -0,0 +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.
+
+export type SourceShopifyBase = {
+  /**
+   * URL of the Shopify store.
+   */
+  shopURL: string;
+};

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

package/model/sourceType.ts

@@ -1,3 +1,12 @@
-// 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 SourceType = 'bigcommerce' | 'commercetools' | 'json';
+export type SourceType =
+  | 'bigcommerce'
+  | 'bigquery'
+  | 'commercetools'
+  | 'csv'
+  | 'docker'
+  | 'ga4BigqueryExport'
+  | 'json'
+  | 'sfcc'
+  | 'shopify';

package/model/sourceUpdate.ts

@@ -1,14 +1,17 @@
-// 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 { SourceInput } from './sourceInput';
-import type { SourceType } from './sourceType';
+import type { SourceUpdateInput } from './sourceUpdateInput';
 
 export type SourceUpdate = {
-  type?: SourceType;
-
+  /**
+   * Descriptive name of the source.
+   */
   name?: string;
 
-  input?: SourceInput;
+  input?: SourceUpdateInput;
 
+  /**
+   * Universally unique identifier (UUID) of an authentication resource.
+   */
   authenticationID?: string;
 };

package/model/sourceUpdateCommercetools.ts

@@ -0,0 +1,21 @@
+// 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 { CommercetoolsCustomFields } from './commercetoolsCustomFields';
+
+export type SourceUpdateCommercetools = {
+  storeKeys?: string[];
+
+  /**
+   * Locales for your commercetools stores.
+   */
+  locales?: string[];
+
+  url?: string;
+
+  /**
+   * Whether a fallback value is stored in the Algolia record if there\'s no inventory information about the product.
+   */
+  fallbackIsInStockValue?: boolean;
+
+  customFields?: CommercetoolsCustomFields;
+};