@algolia/ingestion 1.0.0-beta.3 → 1.0.0-beta.5

package/model/scheduleTrigger.ts

@@ -14,12 +14,12 @@ export type ScheduleTrigger = {
   cron: string;
 
   /**
-   * The last time the scheduled task ran in RFC3339 format.
+   * The last time the scheduled task ran in RFC 3339 format.
    */
   lastRun?: string;
 
   /**
-   * The next scheduled run of the task in RFC3339 format.
+   * The next scheduled run of the task in RFC 3339 format.
    */
   nextRun: 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

@@ -21,12 +21,12 @@ export type Source = {
   authenticationID?: string;
 
   /**
-   * Date of creation in RFC3339 format.
+   * Date of creation in RFC 3339 format.
    */
   createdAt: string;
 
   /**
-   * Date of last update in RFC3339 format.
+   * Date of last update in RFC 3339 format.
    */
   updatedAt?: string;
 };

package/model/sourceCreateResponse.ts

@@ -12,7 +12,7 @@ export type SourceCreateResponse = {
   name: string;
 
   /**
-   * Date of creation in RFC3339 format.
+   * Date of creation in RFC 3339 format.
    */
   createdAt: string;
 };

package/model/sourceUpdateResponse.ts

@@ -12,7 +12,7 @@ export type SourceUpdateResponse = {
   name: string;
 
   /**
-   * Date of last update in RFC3339 format.
+   * Date of last update in RFC 3339 format.
    */
   updatedAt: string;
 };

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/task.ts

@@ -37,12 +37,17 @@ export type Task = {
   action: ActionType;
 
   /**
-   * Date of creation in 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 in RFC3339 format.
+   * Date of last update in RFC 3339 format.
    */
   updatedAt?: string;
 };

package/model/taskCreate.ts

@@ -33,4 +33,9 @@ export type TaskCreate = {
   failureThreshold?: number;
 
   input?: TaskInput;
+
+  /**
+   * Date of the last cursor in RFC 3339 format.
+   */
+  cursor?: string;
 };

package/model/taskCreateResponse.ts

@@ -10,7 +10,7 @@ export type TaskCreateResponse = {
   taskID: string;
 
   /**
-   * Date of creation in RFC3339 format.
+   * Date of creation in RFC 3339 format.
    */
   createdAt: string;
 };

package/model/taskUpdateResponse.ts

@@ -10,7 +10,7 @@ export type TaskUpdateResponse = {
   taskID: string;
 
   /**
-   * Date of last update in 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/{dockerSourceStreams.ts → transformationSearch.ts}

@@ -1,5 +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>>;
+export type TransformationSearch = {
+  transformationsIDs: string[];
 };

package/model/{dockerSourceDiscover.ts → transformationTry.ts}

@@ -1,13 +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 = {
+export type TransformationTry = {
   /**
-   * Universally unique identifier (UUID) of a task run.
+   * The source code of the transformation.
    */
-  runID: string;
+  code: string;
 
   /**
-   * Date of creation in RFC3339 format.
+   * The record to apply the given code to.
    */
-  createdAt: string;
+  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/window.ts

@@ -5,12 +5,12 @@
  */
 export type Window = {
   /**
-   * Date in RFC3339 format representing the oldest data in the time window.
+   * Date in RFC 3339 format representing the oldest data in the time window.
    */
   startDate: string;
 
   /**
-   * Date in RFC3339 format representing the newest data in the time window.
+   * Date in RFC 3339 format representing the newest data in the time window.
    */
   endDate: string;
 };

package/package.json

@@ -1,8 +1,11 @@
 {
   "name": "@algolia/ingestion",
-  "version": "1.0.0-beta.3",
+  "version": "1.0.0-beta.5",
   "description": "JavaScript client for ingestion",
-  "repository": "algolia/algoliasearch-client-javascript",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/algolia/algoliasearch-client-javascript.git"
+  },
   "license": "MIT",
   "author": "Algolia",
   "type": "module",
@@ -39,14 +42,14 @@
     "clean": "rm -rf ./dist || true"
   },
   "dependencies": {
-    "@algolia/client-common": "5.0.0-beta.3",
-    "@algolia/requester-browser-xhr": "5.0.0-beta.3",
-    "@algolia/requester-node-http": "5.0.0-beta.3"
+    "@algolia/client-common": "5.0.0-beta.6",
+    "@algolia/requester-browser-xhr": "5.0.0-beta.6",
+    "@algolia/requester-node-http": "5.0.0-beta.6"
   },
   "devDependencies": {
-    "@types/node": "20.14.2",
+    "@types/node": "20.14.8",
     "rollup": "4.18.0",
-    "typescript": "5.4.5"
+    "typescript": "5.5.2"
   },
   "engines": {
     "node": ">= 14.0.0"

package/dist/model/dockerSourceDiscover.d.ts

@@ -1,11 +0,0 @@
-export type DockerSourceDiscover = {
-    /**
-     * Universally unique identifier (UUID) of a task run.
-     */
-    runID: string;
-    /**
-     * Date of creation in RFC3339 format.
-     */
-    createdAt: string;
-};
-//# sourceMappingURL=dockerSourceDiscover.d.ts.map

package/dist/model/dockerSourceDiscover.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"dockerSourceDiscover.d.ts","sourceRoot":"","sources":["../../model/dockerSourceDiscover.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,oBAAoB,GAAG;IACjC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC"}

package/dist/model/dockerSourceStreams.d.ts

@@ -1,4 +0,0 @@
-export type DockerSourceStreams = {
-    streams: Array<Record<string, any>>;
-};
-//# sourceMappingURL=dockerSourceStreams.d.ts.map

package/dist/model/dockerSourceStreams.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"dockerSourceStreams.d.ts","sourceRoot":"","sources":["../../model/dockerSourceStreams.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,mBAAmB,GAAG;IAChC,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC;CACrC,CAAC"}