@algolia/ingestion 1.0.0-alpha.7 → 1.0.0-alpha.72

package/model/event.ts

@@ -1,19 +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 { EventStatus } from './eventStatus';
 import type { EventType } from './eventType';
 
+/**
+ * An event describe a step of the task execution flow..
+ */
 export type Event = {
+  /**
+   * The event UUID.
+   */
   eventID: string;
 
+  /**
+   * The run UUID.
+   */
   runID: string;
 
+  /**
+   * The parent event, the cause of this event.
+   */
   parentID?: string;
 
   status: EventStatus;
 
   type: EventType;
 
+  /**
+   * The extracted record batch size.
+   */
+  batchSize: number;
+
   data?: Record<string, any>;
 
   /**

package/model/eventSortKeys.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 Event list endpoint.
+ */
+export type EventSortKeys = 'publishedAt' | 'status' | 'type';

package/model/eventStatus.ts

@@ -1,7 +1,8 @@
-// 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 EventStatus =
   | 'created'
+  | 'critical'
   | 'failed'
   | 'retried'
   | 'started'

package/model/eventType.ts

@@ -1,3 +1,3 @@
-// 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 EventType = 'fetch' | 'internal' | 'record';
+export type EventType = 'fetch' | 'log' | 'record' | 'transform';

package/model/index.ts

@@ -1,20 +1,29 @@
-// 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 * from './actionType';
 export * from './authAPIKey';
+export * from './authAPIKeyPartial';
 export * from './authAlgolia';
+export * from './authAlgoliaPartial';
 export * from './authBasic';
+export * from './authBasicPartial';
 export * from './authGoogleServiceAccount';
+export * from './authGoogleServiceAccountPartial';
 export * from './authInput';
+export * from './authInputPartial';
 export * from './authOAuth';
+export * from './authOAuthPartial';
 export * from './authentication';
 export * from './authenticationCreate';
 export * from './authenticationCreateResponse';
-export * from './authenticationInput';
+export * from './authenticationSearch';
+export * from './authenticationSortKeys';
 export * from './authenticationType';
 export * from './authenticationUpdate';
 export * from './authenticationUpdateResponse';
-export * from './authenticationWithInput';
+export * from './bigCommerceChannel';
+export * from './bigCommerceMetafield';
+export * from './bigQueryDataType';
 export * from './deleteResponse';
 export * from './destination';
 export * from './destinationCreate';
@@ -22,11 +31,18 @@ export * from './destinationCreateResponse';
 export * from './destinationIndexName';
 export * from './destinationIndexPrefix';
 export * from './destinationInput';
+export * from './destinationSearch';
+export * from './destinationSortKeys';
 export * from './destinationType';
 export * from './destinationUpdate';
 export * from './destinationUpdateResponse';
+export * from './dockerImageType';
+export * from './dockerRegistry';
+export * from './dockerSourceDiscover';
+export * from './dockerSourceStreams';
 export * from './errorBase';
 export * from './event';
+export * from './eventSortKeys';
 export * from './eventStatus';
 export * from './eventType';
 export * from './listAuthenticationsResponse';
@@ -34,32 +50,62 @@ export * from './listDestinationsResponse';
 export * from './listEventsResponse';
 export * from './listSourcesResponse';
 export * from './listTasksResponse';
+export * from './mappingTypeCSV';
 export * from './methodType';
+export * from './onDemandDateUtilsInput';
+export * from './onDemandTrigger';
+export * from './onDemandTriggerInput';
+export * from './onDemandTriggerType';
+export * from './orderKeys';
 export * from './pagination';
-export * from './platformType';
+export * from './platform';
+export * from './platformNone';
+export * from './platformWithNone';
+export * from './recordType';
 export * from './run';
 export * from './runListResponse';
 export * from './runOutcome';
 export * from './runProgress';
+export * from './runReasonCode';
 export * from './runResponse';
+export * from './runSortKeys';
 export * from './runStatus';
 export * from './runType';
+export * from './scheduleDateUtilsInput';
+export * from './scheduleTrigger';
+export * from './scheduleTriggerInput';
+export * from './scheduleTriggerType';
 export * from './source';
 export * from './sourceBigCommerce';
+export * from './sourceBigQuery';
+export * from './sourceCSV';
 export * from './sourceCommercetools';
 export * from './sourceCreate';
 export * from './sourceCreateResponse';
+export * from './sourceDocker';
 export * from './sourceInput';
-export * from './sourceJson';
+export * from './sourceJSON';
+export * from './sourceSearch';
+export * from './sourceSortKeys';
 export * from './sourceType';
 export * from './sourceUpdate';
+export * from './sourceUpdateCommercetools';
+export * from './sourceUpdateDocker';
+export * from './sourceUpdateInput';
 export * from './sourceUpdateResponse';
+export * from './subscriptionTrigger';
+export * from './subscriptionTriggerType';
 export * from './task';
 export * from './taskCreate';
 export * from './taskCreateResponse';
+export * from './taskCreateTrigger';
+export * from './taskInput';
+export * from './taskSearch';
+export * from './taskSortKeys';
 export * from './taskUpdate';
 export * from './taskUpdateResponse';
 export * from './trigger';
-export * from './triggerInput';
 export * from './triggerType';
+export * from './triggerUpdateInput';
+export * from './window';
 export * from './clientMethodProps';

package/model/listAuthenticationsResponse.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 { Authentication } from './authentication';
 import type { Pagination } from './pagination';

package/model/listDestinationsResponse.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 { Destination } from './destination';
 import type { Pagination } from './pagination';

package/model/listEventsResponse.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 { Event } from './event';
 import type { Pagination } from './pagination';
+import type { Window } from './window';
 
 export type ListEventsResponse = {
   events: Event[];
 
   pagination: Pagination;
+
+  window: Window;
 };

package/model/listSourcesResponse.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 { Pagination } from './pagination';
 import type { Source } from './source';

package/model/listTasksResponse.ts

@@ -1,8 +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.
 
 import type { Pagination } from './pagination';
 import type { Task } from './task';
 
+/**
+ * A list of tasks with pagination details.
+ */
 export type ListTasksResponse = {
   tasks: Task[];
 

package/model/mappingTypeCSV.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 MappingTypeCSV =
+  | 'boolean'
+  | 'float'
+  | 'integer'
+  | 'json'
+  | 'string';

package/model/methodType.ts

@@ -1,3 +1,3 @@
-// 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 MethodType = 'GET' | 'POST';

package/model/onDemandDateUtilsInput.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 input for an `onDemand` 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).
+   */
+  startDate: string;
+
+  /**
+   * The end date of the extraction (RFC3339 format).
+   */
+  endDate: string;
+};

package/model/onDemandTrigger.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 { OnDemandTriggerType } from './onDemandTriggerType';
+
+/**
+ * The trigger information of a task of type `onDemand`.
+ */
+export type OnDemandTrigger = {
+  type: OnDemandTriggerType;
+
+  /**
+   * The last time the scheduled task ran (RFC3339 format).
+   */
+  lastRun?: string;
+};

package/model/onDemandTriggerInput.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 { OnDemandTriggerType } from './onDemandTriggerType';
+
+/**
+ * The trigger information of a task of type `onDemand`.
+ */
+export type OnDemandTriggerInput = {
+  type: OnDemandTriggerType;
+};

package/model/onDemandTriggerType.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 manually executed via the run task endpoint.
+ */
+export type OnDemandTriggerType = 'onDemand';

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

package/model/pagination.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 Pagination = {
   nbPages: number;

package/model/platform.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.
+
+/**
+ * Describe which platform the Authentication is used for.
+ */
+export type Platform = 'bigcommerce' | 'commercetools';

package/model/platformNone.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 filter Authentication without platform property.
+ */
+export type PlatformNone = 'none';

package/model/platformWithNone.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 { Platform } from './platform';
+import type { PlatformNone } from './platformNone';
+
+export type PlatformWithNone = Platform | PlatformNone;

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

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 = {
+  /**
+   * The run UUID.
+   */
   runID: string;
 
   appID: string;
 
+  /**
+   * The task UUID.
+   */
   taskID: string;
 
   status: RunStatus;
@@ -18,17 +25,24 @@ export type Run = {
 
   outcome?: RunOutcome;
 
-  type: RunType;
+  /**
+   * A percentage representing the accepted failure threshold to determine if a `run` succeeded or not.
+   */
+  failureThreshold?: number;
 
   /**
-   * Date of creation (RFC3339 format).
+   * Explains the result of outcome.
    */
-  createdAt: string;
+  reason?: string;
+
+  reasonCode?: RunReasonCode;
+
+  type: RunType;
 
   /**
-   * Date of last update (RFC3339 format).
+   * Date of creation (RFC3339 format).
    */
-  updatedAt: string;
+  createdAt: string;
 
   /**
    * Date of start (RFC3339 format).

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,3 @@
-// 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';
+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.
+
+/**
+ * An identifier that pairs with the outcome reason.
+ */
+export type RunReasonCode =
+  | 'blocking'
+  | 'critical'
+  | 'discarded'
+  | 'internal'
+  | 'no_events'
+  | 'ok'
+  | 'too_many_errors';

package/model/runResponse.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 run task API, containing an Observability Run ID and the time it was created at.
+ */
 export type RunResponse = {
+  /**
+   * The run UUID.
+   */
   runID: 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.
+
+/**
+ * Used to sort the Run list endpoint.
+ */
+export type RunSortKeys = 'createdAt' | 'status' | 'updatedAt';

package/model/runStatus.ts

@@ -1,3 +1,8 @@
-// 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';
+export type RunStatus =
+  | 'created'
+  | 'finished'
+  | 'idled'
+  | 'skipped'
+  | 'started';

package/model/runType.ts

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

package/model/scheduleDateUtilsInput.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.
+
+/**
+ * The input for a `schedule` task 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.
+   */
+  timeframe: number;
+};

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';
+
+/**
+ * The trigger information for a task of type \'schedule\'.
+ */
+export type ScheduleTrigger = {
+  type: ScheduleTriggerType;
+
+  /**
+   * A cron expression that represent at which regularity the task should run.
+   */
+  cron: string;
+
+  /**
+   * The last time the scheduled task ran (RFC3339 format).
+   */
+  lastRun?: string;
+
+  /**
+   * The next scheduled run of the task (RFC3339 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';
+
+/**
+ * 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 = {
+  /**
+   * 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;
+};