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

package/model/destinationType.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 DestinationType = 'flow' | 'insights' | 'predict' | 'search';
+/**
+ * Destination type.  - `search`.   Data is stored in an Algolia index.  - `insights`.   Data is recorded as user events in the Insights API.
+ */
+export type DestinationType = 'insights' | 'search';

package/model/destinationUpdate.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 { DestinationInput } from './destinationInput';
 import type { DestinationType } from './destinationType';
 
+/**
+ * API request body for updating a destination.
+ */
 export type DestinationUpdate = {
   type?: DestinationType;
 
+  /**
+   * Descriptive name for the resource.
+   */
   name?: string;
 
   input?: DestinationInput;
 
+  /**
+   * Universally unique identifier (UUID) of an authentication resource.
+   */
   authenticationID?: string;
 };

package/model/destinationUpdateResponse.ts

@@ -1,12 +1,21 @@
-// 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 destination.
+ */
 export type DestinationUpdateResponse = {
+  /**
+   * Universally unique identifier (UUID) of a destination resource.
+   */
   destinationID: string;
 
+  /**
+   * Descriptive name for the resource.
+   */
   name: string;
 
   /**
-   * Date of last update (RFC3339 format).
+   * Date of last update in RFC3339 format.
    */
   updatedAt: string;
 };

package/model/dockerImageType.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.
+
+/**
+ * Image type.
+ */
+export type DockerImageType = 'airbyte' | 'custom' | 'singer';

package/model/dockerRegistry.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.
+
+/**
+ * Container registry name from where to pull the image.
+ */
+export type DockerRegistry = 'dockerhub' | 'ghcr';

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

package/model/dockerSourceStreams.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 DockerSourceStreams = {
+  streams: Array<Record<string, any>>;
+};

package/model/errorBase.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.
 
 /**
  * Error.

package/model/event.ts

@@ -1,23 +1,40 @@
-// 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 = {
+  /**
+   * Universally unique identifier (UUID) of an event.
+   */
   eventID: string;
 
+  /**
+   * Universally unique identifier (UUID) of a task run.
+   */
   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>;
 
   /**
-   * Date of publish (RFC3339 format).
+   * Date of publish RFC3339 format.
    */
   publishedAt: string;
 };

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.
+
+/**
+ * Property by which to sort the list of task run events.
+ */
+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,32 @@
-// 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 './authAlgoliaInsights';
+export * from './authAlgoliaInsightsPartial';
+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 './commercetoolsCustomFields';
 export * from './deleteResponse';
 export * from './destination';
 export * from './destinationCreate';
@@ -22,11 +34,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 +53,76 @@ export * from './listDestinationsResponse';
 export * from './listEventsResponse';
 export * from './listSourcesResponse';
 export * from './listTasksResponse';
+export * from './mappingFieldDirective';
+export * from './mappingFormatSchema';
+export * from './mappingInput';
+export * from './mappingKitAction';
+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 './shopifyInput';
+export * from './shopifyMarket';
+export * from './shopifyMetafield';
 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 './sourceGA4BigQueryExport';
 export * from './sourceInput';
-export * from './sourceJson';
+export * from './sourceJSON';
+export * from './sourceSearch';
+export * from './sourceShopify';
+export * from './sourceShopifyBase';
+export * from './sourceSortKeys';
 export * from './sourceType';
 export * from './sourceUpdate';
+export * from './sourceUpdateCommercetools';
+export * from './sourceUpdateDocker';
+export * from './sourceUpdateInput';
 export * from './sourceUpdateResponse';
+export * from './sourceUpdateShopify';
+export * from './streamingTrigger';
+export * from './streamingTriggerType';
+export * from './streamingUtilsInput';
+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';
 
+/**
+ * Configured tasks and pagination information.
+ */
 export type ListTasksResponse = {
   tasks: Task[];
 

package/model/mappingFieldDirective.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.
+
+/**
+ * Describes how a field should be resolved by applying a set of directives.
+ */
+export type MappingFieldDirective = {
+  /**
+   * Destination field key.
+   */
+  fieldKey: string;
+
+  /**
+   * How the destination field should be resolved from the source.
+   */
+  value: Record<string, any>;
+};

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

@@ -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 { MappingFormatSchema } from './mappingFormatSchema';
+import type { MappingKitAction } from './mappingKitAction';
+
+/**
+ * Transformations to apply to the source, serialized as a JSON string.
+ */
+export type MappingInput = {
+  format: MappingFormatSchema;
+
+  actions: MappingKitAction[];
+};

package/model/mappingKitAction.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 { MappingFieldDirective } from './mappingFieldDirective';
+
+/**
+ * Describes how a destination object should be resolved by means of applying a set of directives.
+ */
+export type MappingKitAction = {
+  /**
+   * ID to uniquely identify this action.
+   */
+  id?: string;
+
+  /**
+   * Whether this action has any effect.
+   */
+  enabled: boolean;
+
+  /**
+   * Condition which must be satisfied to apply the action. If this evaluates to false, the action is not applied, and the process attempts to apply the next action, if any.
+   */
+  trigger: string;
+
+  fieldDirectives: MappingFieldDirective[];
+};

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

package/model/onDemandDateUtilsInput.ts

@@ -0,0 +1,20 @@
+// 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 manually-triggered task whose source is of type `bigquery` and for which extracted data spans a given time range.
+ */
+export type OnDemandDateUtilsInput = {
+  /**
+   * Earliest date in RFC3339 format of the extracted data from Big Query.
+   */
+  startDate: string;
+
+  /**
+   * Latest date in RFC3339 format of the extracted data from Big Query.
+   */
+  endDate: string;
+
+  mapping?: MappingInput;
+};

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';
+
+/**
+ * Trigger information for manually-triggered tasks.
+ */
+export type OnDemandTrigger = {
+  type: OnDemandTriggerType;
+
+  /**
+   * The last time the scheduled task ran in 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';
+
+/**
+ * Trigger information for manually-triggered tasks.
+ */
+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.
+
+/**
+ * Task is run manually, with the `/run` 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.
+
+/**
+ * Ascending or descending sort order.
+ */
+export type OrderKeys = 'asc' | 'desc';

package/model/pagination.ts

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

@@ -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.
+
+/**
+ * Name of an ecommerce platform with which to authenticate. This determines which authentication type you can select.
+ */
+export type Platform = 'bigcommerce' | 'commercetools' | 'shopify';

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.
+
+/**
+ * Authentication resource not tied to any ecommerce platform, used for filtering.
+ */
+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.
+
+/**
+ * Record type for ecommerce sources.
+ */
+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 = {
+  /**
+   * 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 RFC3339 format.
    */
-  updatedAt: string;
+  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;
 };