@algolia/ingestion 1.0.0-alpha.8 → 1.0.0-alpha.81

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';
+
+/**
+ * The trigger input for a task of type \'schedule\'.
+ */
+export type ScheduleTriggerInput = {
+  type: ScheduleTriggerType;
+
+  /**
+   * A cron expression that represent at which regularity the task should run.
+   */
+  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.
+
+/**
+ * A task which is triggered by a schedule (cron expression).
+ */
+export type ScheduleTriggerType = 'schedule';

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 = {
+  /**
+   * The source UUID.
+   */
   sourceID: string;
 
   type: SourceType;
@@ -12,6 +15,9 @@ export type Source = {
 
   input: SourceInput;
 
+  /**
+   * The authentication UUID.
+   */
   authenticationID?: 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;
+  /**
+   * The store hash identifying the store the shopper is signing in to.
+   */
+  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 default BQ).
+   */
+  table?: string;
+
+  /**
+   * Table prefix (for Google Analytics).
+   */
+  tablePrefix?: string;
+
+  /**
+   * Custom SQL request to extract data from the BigQuery table.
+   */
+  customSQLRequest?: string;
+
+  /**
+   * The name of the column that contains the unique ID, 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 = {
+  /**
+   * The URL of the file.
+   */
+  url: string;
+
+  /**
+   * The name of the column that contains the unique ID, used as `objectID` in Algolia.
+   */
+  uniqueIDColumn?: string;
+
+  /**
+   * Mapping of type for every column. For example {\"myColumn\": \"boolean\", \"myOtherColumn\": \"json\"}.
+   */
+  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,4 +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.
+
+import type { CommercetoolsCustomFields } from './commercetoolsCustomFields';
 
 export type SourceCommercetools = {
   storeKeys?: string[];
@@ -11,4 +13,11 @@ export type SourceCommercetools = {
   url: string;
 
   projectKey: string;
+
+  /**
+   * Determines the value that will be stored in the Algolia record if there\'s no inventory information on 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';
@@ -10,5 +10,8 @@ export type SourceCreate = {
 
   input: SourceInput;
 
-  authenticationID: string;
+  /**
+   * The authentication UUID.
+   */
+  authenticationID?: string;
 };

package/model/sourceCreateResponse.ts

@@ -1,6 +1,9 @@
-// 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 = {
+  /**
+   * The source UUID.
+   */
   sourceID: string;
 
   name: 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;
+
+  /**
+   * The name of the image to pull.
+   */
+  image: string;
+
+  /**
+   * The version of the image, defaults to `latest`.
+   */
+  version?: string;
+
+  /**
+   * The 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 (i.e. Events_intraday_ for streaming, events_ for daily).
+   */
+  tablePrefix: string;
+};

package/model/sourceInput.ts

@@ -1,7 +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.
 
 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';
 
-export type SourceInput = SourceBigCommerce | SourceCommercetools | SourceJson;
+export type SourceInput =
+  | SourceBigCommerce
+  | SourceBigQuery
+  | SourceCommercetools
+  | SourceCSV
+  | SourceDocker
+  | SourceGA4BigQueryExport
+  | SourceJSON;

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 = {
+  /**
+   * The URL of the file.
+   */
+  url: string;
+
+  /**
+   * The name of the column that contains the unique ID, 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/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.
+
+/**
+ * Used to sort the Source list endpoint.
+ */
+export type SourceSortKeys = 'createdAt' | 'name' | 'type' | 'updatedAt';

package/model/sourceType.ts

@@ -1,3 +1,10 @@
-// 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';

package/model/sourceUpdate.ts

@@ -1,14 +1,14 @@
-// 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;
-
   name?: string;
 
-  input?: SourceInput;
+  input?: SourceUpdateInput;
 
+  /**
+   * The authentication UUID.
+   */
   authenticationID?: string;
 };

package/model/sourceUpdateCommercetools.ts

@@ -0,0 +1,24 @@
+// 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 = {
+  /**
+   * 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?: string[];
+
+  url?: string;
+
+  /**
+   * Determines the value that will be stored in the Algolia record if there\'s no inventory information on the product.
+   */
+  fallbackIsInStockValue?: boolean;
+
+  customFields?: CommercetoolsCustomFields;
+};

package/model/sourceUpdateDocker.ts

@@ -0,0 +1,22 @@
+// 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 { DockerRegistry } from './dockerRegistry';
+
+export type SourceUpdateDocker = {
+  registry?: DockerRegistry;
+
+  /**
+   * The name of the image to pull.
+   */
+  image?: string;
+
+  /**
+   * The version of the image, defaults to `latest`.
+   */
+  version?: string;
+
+  /**
+   * The configuration of the spec.
+   */
+  configuration: Record<string, any>;
+};

package/model/sourceUpdateInput.ts

@@ -0,0 +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.
+
+import type { SourceBigQuery } from './sourceBigQuery';
+import type { SourceCSV } from './sourceCSV';
+import type { SourceGA4BigQueryExport } from './sourceGA4BigQueryExport';
+import type { SourceJSON } from './sourceJSON';
+import type { SourceUpdateCommercetools } from './sourceUpdateCommercetools';
+import type { SourceUpdateDocker } from './sourceUpdateDocker';
+
+export type SourceUpdateInput =
+  | SourceBigQuery
+  | SourceCSV
+  | SourceGA4BigQueryExport
+  | SourceJSON
+  | SourceUpdateCommercetools
+  | SourceUpdateDocker;

package/model/sourceUpdateResponse.ts

@@ -1,6 +1,9 @@
-// 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 SourceUpdateResponse = {
+  /**
+   * The source UUID.
+   */
   sourceID: string;
 
   name: string;

package/model/streamingTrigger.ts

@@ -0,0 +1,10 @@
+// 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 { StreamingTriggerType } from './streamingTriggerType';
+
+/**
+ * The trigger input for a task of type \'streaming\'.
+ */
+export type StreamingTrigger = {
+  type: StreamingTriggerType;
+};

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

package/model/streamingUtilsInput.ts

@@ -0,0 +1,10 @@
+// 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 { MappingInput } from './mappingInput';
+
+/**
+ * The 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

@@ -0,0 +1,10 @@
+// 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 { SubscriptionTriggerType } from './subscriptionTriggerType';
+
+/**
+ * The trigger input for a task of type \'subscription\'.
+ */
+export type SubscriptionTrigger = {
+  type: SubscriptionTriggerType;
+};

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

package/model/task.ts

@@ -1,19 +1,39 @@
-// 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 { ActionType } from './actionType';
+import type { TaskInput } from './taskInput';
 import type { Trigger } from './trigger';
 
 export type Task = {
+  /**
+   * The task UUID.
+   */
   taskID: string;
 
+  /**
+   * The source UUID.
+   */
   sourceID: string;
 
+  /**
+   * The destination UUID.
+   */
   destinationID: string;
 
-  trigger?: Trigger;
+  trigger: Trigger;
 
+  input?: TaskInput;
+
+  /**
+   * Whether the task is enabled or not.
+   */
   enabled: boolean;
 
+  /**
+   * A percentage representing the accepted failure threshold to determine if a `run` succeeded or not.
+   */
+  failureThreshold?: number;
+
   action: ActionType;
 
   /**

package/model/taskCreate.ts

@@ -1,16 +1,36 @@
-// 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 { ActionType } from './actionType';
-import type { TriggerInput } from './triggerInput';
+import type { TaskCreateTrigger } from './taskCreateTrigger';
+import type { TaskInput } from './taskInput';
 
+/**
+ * The payload for a task creation.
+ */
 export type TaskCreate = {
+  /**
+   * The source UUID.
+   */
   sourceID: string;
 
+  /**
+   * The destination UUID.
+   */
   destinationID: string;
 
-  trigger: TriggerInput;
+  trigger: TaskCreateTrigger;
 
   action: ActionType;
 
+  /**
+   * Whether the task is enabled or not.
+   */
   enabled?: boolean;
+
+  /**
+   * A percentage representing the accepted failure threshold to determine if a `run` succeeded or not.
+   */
+  failureThreshold?: number;
+
+  input?: TaskInput;
 };

package/model/taskCreateResponse.ts

@@ -1,6 +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.
 
+/**
+ * The response from the API after a task creation.
+ */
 export type TaskCreateResponse = {
+  /**
+   * The task UUID.
+   */
   taskID: string;
 
   /**

package/model/taskCreateTrigger.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.
+
+import type { OnDemandTriggerInput } from './onDemandTriggerInput';
+import type { ScheduleTriggerInput } from './scheduleTriggerInput';
+import type { StreamingTrigger } from './streamingTrigger';
+import type { SubscriptionTrigger } from './subscriptionTrigger';
+
+export type TaskCreateTrigger =
+  | OnDemandTriggerInput
+  | ScheduleTriggerInput
+  | StreamingTrigger
+  | SubscriptionTrigger;

package/model/taskInput.ts

@@ -0,0 +1,10 @@
+// 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 { OnDemandDateUtilsInput } from './onDemandDateUtilsInput';
+import type { ScheduleDateUtilsInput } from './scheduleDateUtilsInput';
+import type { StreamingUtilsInput } from './streamingUtilsInput';
+
+export type TaskInput =
+  | OnDemandDateUtilsInput
+  | ScheduleDateUtilsInput
+  | StreamingUtilsInput;

package/model/taskSearch.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 TaskSearch = {
+  taskIDs: string[];
+};

package/model/taskSortKeys.ts

@@ -0,0 +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.
+
+/**
+ * Used to sort the Task list endpoint.
+ */
+export type TaskSortKeys =
+  | 'action'
+  | 'createdAt'
+  | 'enabled'
+  | 'triggerType'
+  | 'updatedAt';

package/model/taskUpdate.ts

@@ -1,11 +1,28 @@
-// 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 { TriggerInput } from './triggerInput';
+import type { TaskInput } from './taskInput';
+import type { TriggerUpdateInput } from './triggerUpdateInput';
 
+/**
+ * The payload for a task update.
+ */
 export type TaskUpdate = {
+  /**
+   * The destination UUID.
+   */
   destinationID?: string;
 
-  trigger?: TriggerInput;
+  trigger?: TriggerUpdateInput;
 
+  input?: TaskInput;
+
+  /**
+   * Whether the task is enabled or not.
+   */
   enabled?: boolean;
+
+  /**
+   * A percentage representing the accepted failure threshold to determine if a `run` succeeded or not.
+   */
+  failureThreshold?: number;
 };

package/model/taskUpdateResponse.ts

@@ -1,6 +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.
 
+/**
+ * The response from the API after a task update.
+ */
 export type TaskUpdateResponse = {
+  /**
+   * The task UUID.
+   */
   taskID: string;
 
   /**