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

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;
+
+  /**
+   * Docker image name.
+   */
+  image?: string;
+
+  /**
+   * Docker image version.
+   */
+  version?: string;
+
+  /**
+   * Configuration of the spec.
+   */
+  configuration: Record<string, any>;
+};

package/model/sourceUpdateInput.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.
+
+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';
+import type { SourceUpdateShopify } from './sourceUpdateShopify';
+
+export type SourceUpdateInput =
+  | SourceBigQuery
+  | SourceCSV
+  | SourceGA4BigQueryExport
+  | SourceJSON
+  | SourceUpdateCommercetools
+  | SourceUpdateDocker
+  | SourceUpdateShopify;

package/model/sourceUpdateResponse.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 SourceUpdateResponse = {
+  /**
+   * 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 RFC 3339 format.
    */
   updatedAt: string;
 };

package/model/sourceUpdateShopify.ts

@@ -0,0 +1,38 @@
+// 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 SourceUpdateShopify = {
+  /**
+   * Whether to index collection IDs.   If your store has `has_collection_search_page` set to true, collection IDs will be indexed even if `collectionIDIndexing` is false.
+   */
+  collectionIDIndexing?: boolean;
+
+  /**
+   * Whether to increase the number of indexed collections per product. If true, Algolia indexes 200 collections per product. If false, 100 collections per product are indexed.
+   */
+  increaseProductCollectionLimit?: boolean;
+
+  /**
+   * Whether to set the default price ratio to 1 if no sale price is present.  The price ratio is determined by the ratio: `sale_price` / `regular_price`. If no sale price is present, the price ratio would be 0. If `defaultPriceRatioAsOne` is true, the price ratio is indexed as 1 instead.
+   */
+  defaultPriceRatioAsOne?: boolean;
+
+  /**
+   * Whether to exclude out-of-stock variants when determining the `max_variant_price` and `min_variant_price` attributes.
+   */
+  excludeOOSVariantsForPriceAtTRS?: boolean;
+
+  /**
+   * Whether to include an inventory with every variant for every product record.
+   */
+  includeVariantsInventory?: boolean;
+
+  /**
+   * Whether to include collection IDs and handles in the product records.
+   */
+  hasCollectionSearchPage?: boolean;
+
+  /**
+   * Whether to convert tags on products to named tags.  To learn more, see [Named tags](https://www.algolia.com/doc/integration/shopify/sending-and-managing-data/named-tags).
+   */
+  productNamedTags?: boolean;
+};

package/model/sourceWatchResponse.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 { Event } from './event';
+
+export type SourceWatchResponse = {
+  /**
+   * Universally unique identifier (UUID) of a task run.
+   */
+  runID?: string;
+
+  /**
+   * Depending on the source type, the validation returns sampling data of your source (JSON, CSV, BigQuery).
+   */
+  data?: Array<Record<string, any>>;
+
+  /**
+   * In case of error, observability events will be added to the response, if any.
+   */
+  events?: Event[];
+
+  /**
+   * A message describing the outcome of a validate run.
+   */
+  message: string;
+};

package/model/streamingInput.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';
+
+/**
+ * Input for a `streaming` task whose source is of type `ga4BigqueryExport` and for which extracted data is continuously streamed.
+ */
+export type StreamingInput = {
+  mapping: MappingInput;
+};

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';
+
+/**
+ * Trigger input for continuously running tasks.
+ */
+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.
+
+/**
+ * Task runs continuously.
+ */
+export type StreamingTriggerType = 'streaming';

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';
+
+/**
+ * Trigger input for subscription tasks.
+ */
+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.
+
+/**
+ * Task runs after receiving subscribed event.
+ */
+export type SubscriptionTriggerType = 'subscription';

package/model/task.ts

@@ -1,28 +1,53 @@
-// 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 = {
+  /**
+   * Universally unique identifier (UUID) of a task.
+   */
   taskID: string;
 
+  /**
+   * Universally uniqud identifier (UUID) of a source.
+   */
   sourceID: string;
 
+  /**
+   * Universally unique identifier (UUID) of a destination resource.
+   */
   destinationID: string;
 
-  trigger?: Trigger;
+  trigger: Trigger;
 
+  input?: TaskInput;
+
+  /**
+   * Whether the task is enabled.
+   */
   enabled: boolean;
 
+  /**
+   * Maximum accepted percentage of failures for a task run to finish successfully.
+   */
+  failureThreshold?: number;
+
   action: ActionType;
 
   /**
-   * Date of creation (RFC3339 format).
+   * Date of the last cursor in RFC 3339 format.
+   */
+  cursor?: string;
+
+  /**
+   * 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/taskCreate.ts

@@ -1,16 +1,41 @@
-// 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';
 
+/**
+ * API request body for creating a task.
+ */
 export type TaskCreate = {
+  /**
+   * Universally uniqud identifier (UUID) of a source.
+   */
   sourceID: string;
 
+  /**
+   * Universally unique identifier (UUID) of a destination resource.
+   */
   destinationID: string;
 
-  trigger: TriggerInput;
+  trigger: TaskCreateTrigger;
 
   action: ActionType;
 
+  /**
+   * Whether the task is enabled.
+   */
   enabled?: boolean;
+
+  /**
+   * Maximum accepted percentage of failures for a task run to finish successfully.
+   */
+  failureThreshold?: number;
+
+  input?: TaskInput;
+
+  /**
+   * Date of the last cursor in RFC 3339 format.
+   */
+  cursor?: string;
 };

package/model/taskCreateResponse.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 creating a task.
+ */
 export type TaskCreateResponse = {
+  /**
+   * Universally unique identifier (UUID) of a task.
+   */
   taskID: string;
 
   /**
-   * Date of creation (RFC3339 format).
+   * Date of creation in RFC 3339 format.
    */
   createdAt: 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 { DockerStreamsInput } from './dockerStreamsInput';
+import type { ShopifyInput } from './shopifyInput';
+import type { StreamingInput } from './streamingInput';
+
+/**
+ * Configuration of the task, depending on its type.
+ */
+export type TaskInput = DockerStreamsInput | ShopifyInput | StreamingInput;

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.
+
+/**
+ * Property by which to sort the list of tasks.
+ */
+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';
 
+/**
+ * API request body for updating a task.
+ */
 export type TaskUpdate = {
+  /**
+   * Universally unique identifier (UUID) of a destination resource.
+   */
   destinationID?: string;
 
-  trigger?: TriggerInput;
+  trigger?: TriggerUpdateInput;
 
+  input?: TaskInput;
+
+  /**
+   * Whether the task is enabled.
+   */
   enabled?: boolean;
+
+  /**
+   * Maximum accepted percentage of failures for a task run to finish successfully.
+   */
+  failureThreshold?: number;
 };

package/model/taskUpdateResponse.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 updating a task.
+ */
 export type TaskUpdateResponse = {
+  /**
+   * Universally unique identifier (UUID) of a task.
+   */
   taskID: string;
 
   /**
-   * Date of last update (RFC3339 format).
+   * Date of last update in RFC 3339 format.
    */
   updatedAt: string;
 };

package/model/transformation.ts

@@ -0,0 +1,33 @@
+// 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 Transformation = {
+  /**
+   * Universally unique identifier (UUID) of a transformation.
+   */
+  transformationID: string;
+
+  /**
+   * The source code of the transformation.
+   */
+  code: string;
+
+  /**
+   * The uniquely identified name of your transformation.
+   */
+  name: string;
+
+  /**
+   * A descriptive name for your transformation of what it does.
+   */
+  description?: string;
+
+  /**
+   * Date of creation in RFC 3339 format.
+   */
+  createdAt: string;
+
+  /**
+   * Date of last update in RFC 3339 format.
+   */
+  updatedAt?: string;
+};

package/model/transformationCreate.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.
+
+/**
+ * API request body for creating a transformation.
+ */
+export type TransformationCreate = {
+  /**
+   * The source code of the transformation.
+   */
+  code: string;
+
+  /**
+   * The uniquely identified name of your transformation.
+   */
+  name: string;
+
+  /**
+   * A descriptive name for your transformation of what it does.
+   */
+  description?: string;
+};

package/model/transformationCreateResponse.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.
+
+/**
+ * API response for creating a transformation.
+ */
+export type TransformationCreateResponse = {
+  /**
+   * Universally unique identifier (UUID) of a transformation.
+   */
+  transformationID: string;
+
+  /**
+   * Date of creation in RFC 3339 format.
+   */
+  createdAt: string;
+};

package/model/transformationSearch.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 TransformationSearch = {
+  transformationsIDs: string[];
+};

package/model/transformationTry.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.
+
+export type TransformationTry = {
+  /**
+   * The source code of the transformation.
+   */
+  code: string;
+
+  /**
+   * The record to apply the given code to.
+   */
+  sampleRecord: Record<string, any>;
+};

package/model/transformationTryResponse.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 { TransformationTryResponseError } from './transformationTryResponseError';
+
+export type TransformationTryResponse = {
+  /**
+   * The array of records returned by the transformation service.
+   */
+  payloads: Array<Record<string, any>>;
+
+  error?: TransformationTryResponseError;
+};

package/model/transformationTryResponseError.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.
+
+/**
+ * The error if the transformation failed.
+ */
+export type TransformationTryResponseError = {
+  /**
+   * The error status code.
+   */
+  code?: number;
+
+  /**
+   * A descriptive message explaining the failure.
+   */
+  message?: string;
+};

package/model/transformationUpdateResponse.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.
+
+/**
+ * API response for updating a transformation.
+ */
+export type TransformationUpdateResponse = {
+  /**
+   * Universally unique identifier (UUID) of a transformation.
+   */
+  transformationID: string;
+
+  /**
+   * Date of last update in RFC 3339 format.
+   */
+  updatedAt: string;
+};

package/model/trigger.ts

@@ -1,19 +1,15 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
-
-import type { TriggerType } from './triggerType';
-
-export type Trigger = {
-  type: TriggerType;
-
-  cron?: string;
-
-  /**
-   * The last time the task ran (`scheduled` or `on-demand`).
-   */
-  lastRun?: string;
-
-  /**
-   * The next scheduled run for the task (`scheduled`).
-   */
-  nextRun?: string;
-};
+// 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 { 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;

package/model/triggerType.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 TriggerType = 'on_demand' | 'schedule' | 'subscription';
+/**
+ * Task trigger, describing when a task should run.  - `onDemand`.   Manually trigger the task with the `/run` endpoint.  - `schedule`.   Regularly trigger the task on a `cron` schedule.  - `subscription`.   Trigger the task after an event is received, such as, a webhook.  - `streaming`.   Run the task continuously.
+ */
+export type TriggerType =
+  | 'onDemand'
+  | 'schedule'
+  | 'streaming'
+  | 'subscription';

package/model/triggerUpdateInput.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.
+
+/**
+ * Trigger for a task update.
+ */
+export type TriggerUpdateInput = {
+  /**
+   * Cron expression for the task\'s schedule.
+   */
+  cron: string;
+};

package/model/window.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.
+
+/**
+ * Time window by which to filter the observability data.
+ */
+export type Window = {
+  /**
+   * Date in RFC 3339 format representing the oldest data in the time window.
+   */
+  startDate: string;
+
+  /**
+   * Date in RFC 3339 format representing the newest data in the time window.
+   */
+  endDate: string;
+};