@algolia/ingestion 1.0.0-alpha.10

package/model/run.ts

@@ -0,0 +1,42 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { RunOutcome } from './runOutcome';
+import type { RunProgress } from './runProgress';
+import type { RunStatus } from './runStatus';
+import type { RunType } from './runType';
+
+export type Run = {
+  runID: string;
+
+  appID: string;
+
+  taskID: string;
+
+  status: RunStatus;
+
+  progress?: RunProgress;
+
+  outcome?: RunOutcome;
+
+  type: RunType;
+
+  /**
+   * Date of creation (RFC3339 format).
+   */
+  createdAt: string;
+
+  /**
+   * Date of last update (RFC3339 format).
+   */
+  updatedAt: string;
+
+  /**
+   * Date of start (RFC3339 format).
+   */
+  startedAt?: string;
+
+  /**
+   * Date of finish (RFC3339 format).
+   */
+  finishedAt?: string;
+};

package/model/runListResponse.ts

@@ -0,0 +1,10 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { Pagination } from './pagination';
+import type { Run } from './run';
+
+export type RunListResponse = {
+  runs: Run[];
+
+  pagination: Pagination;
+};

package/model/runOutcome.ts

@@ -0,0 +1,3 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export type RunOutcome = 'failure' | 'success';

package/model/runProgress.ts

@@ -0,0 +1,7 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export type RunProgress = {
+  expectedNbOfEvents?: number;
+
+  receivedNbOfEvents?: number;
+};

package/model/runResponse.ts

@@ -0,0 +1,10 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export type RunResponse = {
+  runID: string;
+
+  /**
+   * Date of creation (RFC3339 format).
+   */
+  createdAt: string;
+};

package/model/runStatus.ts

@@ -0,0 +1,3 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export type RunStatus = 'created' | 'finished' | 'started';

package/model/runType.ts

@@ -0,0 +1,3 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export type RunType = 'reindex' | 'update';

package/model/source.ts

@@ -0,0 +1,26 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { SourceInput } from './sourceInput';
+import type { SourceType } from './sourceType';
+
+export type Source = {
+  sourceID: string;
+
+  type: SourceType;
+
+  name: string;
+
+  input: SourceInput;
+
+  authenticationID?: string;
+
+  /**
+   * Date of creation (RFC3339 format).
+   */
+  createdAt: string;
+
+  /**
+   * Date of last update (RFC3339 format).
+   */
+  updatedAt?: string;
+};

package/model/sourceBigCommerce.ts

@@ -0,0 +1,5 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export type SourceBigCommerce = {
+  storeHash?: string;
+};

package/model/sourceCommercetools.ts

@@ -0,0 +1,14 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export type SourceCommercetools = {
+  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;
+
+  projectKey: string;
+};

package/model/sourceCreate.ts

@@ -0,0 +1,14 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { SourceInput } from './sourceInput';
+import type { SourceType } from './sourceType';
+
+export type SourceCreate = {
+  type: SourceType;
+
+  name: string;
+
+  input: SourceInput;
+
+  authenticationID: string;
+};

package/model/sourceCreateResponse.ts

@@ -0,0 +1,12 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export type SourceCreateResponse = {
+  sourceID: string;
+
+  name: string;
+
+  /**
+   * Date of creation (RFC3339 format).
+   */
+  createdAt: string;
+};

package/model/sourceInput.ts

@@ -0,0 +1,7 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { SourceBigCommerce } from './sourceBigCommerce';
+import type { SourceCommercetools } from './sourceCommercetools';
+import type { SourceJson } from './sourceJson';
+
+export type SourceInput = SourceBigCommerce | SourceCommercetools | SourceJson;

package/model/sourceJson.ts

@@ -0,0 +1,9 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { MethodType } from './methodType';
+
+export type SourceJson = {
+  url: string;
+
+  method?: MethodType;
+};

package/model/sourceType.ts

@@ -0,0 +1,3 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export type SourceType = 'bigcommerce' | 'commercetools' | 'json';

package/model/sourceUpdate.ts

@@ -0,0 +1,14 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { SourceInput } from './sourceInput';
+import type { SourceType } from './sourceType';
+
+export type SourceUpdate = {
+  type?: SourceType;
+
+  name?: string;
+
+  input?: SourceInput;
+
+  authenticationID?: string;
+};

package/model/sourceUpdateResponse.ts

@@ -0,0 +1,12 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export type SourceUpdateResponse = {
+  sourceID: string;
+
+  name: string;
+
+  /**
+   * Date of last update (RFC3339 format).
+   */
+  updatedAt: string;
+};

package/model/task.ts

@@ -0,0 +1,28 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { ActionType } from './actionType';
+import type { Trigger } from './trigger';
+
+export type Task = {
+  taskID: string;
+
+  sourceID: string;
+
+  destinationID: string;
+
+  trigger?: Trigger;
+
+  enabled: boolean;
+
+  action: ActionType;
+
+  /**
+   * Date of creation (RFC3339 format).
+   */
+  createdAt: string;
+
+  /**
+   * Date of last update (RFC3339 format).
+   */
+  updatedAt?: string;
+};

package/model/taskCreate.ts

@@ -0,0 +1,16 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { ActionType } from './actionType';
+import type { TriggerInput } from './triggerInput';
+
+export type TaskCreate = {
+  sourceID: string;
+
+  destinationID: string;
+
+  trigger: TriggerInput;
+
+  action: ActionType;
+
+  enabled?: boolean;
+};

package/model/taskCreateResponse.ts

@@ -0,0 +1,10 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export type TaskCreateResponse = {
+  taskID: string;
+
+  /**
+   * Date of creation (RFC3339 format).
+   */
+  createdAt: string;
+};

package/model/taskUpdate.ts

@@ -0,0 +1,11 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { TriggerInput } from './triggerInput';
+
+export type TaskUpdate = {
+  destinationID?: string;
+
+  trigger?: TriggerInput;
+
+  enabled?: boolean;
+};

package/model/taskUpdateResponse.ts

@@ -0,0 +1,10 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export type TaskUpdateResponse = {
+  taskID: string;
+
+  /**
+   * Date of last update (RFC3339 format).
+   */
+  updatedAt: string;
+};

package/model/trigger.ts

@@ -0,0 +1,19 @@
+// 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;
+};

package/model/triggerInput.ts

@@ -0,0 +1,9 @@
+// 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 TriggerInput = {
+  type: TriggerType;
+
+  cron?: string;
+};

package/model/triggerType.ts

@@ -0,0 +1,3 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export type TriggerType = 'on_demand' | 'schedule' | 'subscription';

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@algolia/ingestion",
+  "version": "1.0.0-alpha.10",
+  "description": "JavaScript client for ingestion",
+  "repository": "algolia/algoliasearch-client-javascript",
+  "license": "MIT",
+  "author": "Algolia",
+  "exports": {
+    ".": {
+      "node": {
+        "import": "./dist/ingestion.esm.node.js",
+        "module": "./dist/ingestion.esm.node.js",
+        "require": "./dist/ingestion.cjs.js",
+        "default": "./dist/ingestion.cjs.js"
+      },
+      "default": {
+        "umd": "./dist/ingestion.umd.js",
+        "module": "./dist/ingestion.esm.browser.js",
+        "import": "./dist/ingestion.esm.browser.js",
+        "default": "./dist/ingestion.umd.js"
+      }
+    },
+    "./src/*": "./src/*.ts",
+    "./model": "./model/index.ts"
+  },
+  "jsdelivr": "./dist/ingestion.umd.js",
+  "unpkg": "./dist/ingestion.umd.js",
+  "browser": "./dist/ingestion.umd.js",
+  "types": "./index.d.ts",
+  "files": [
+    "dist",
+    "model",
+    "index.js",
+    "index.d.ts"
+  ],
+  "scripts": {
+    "build": "yarn clean && rollup --config",
+    "clean": "rm -rf ./dist || true"
+  },
+  "dependencies": {
+    "@algolia/client-common": "5.0.0-alpha.36",
+    "@algolia/requester-browser-xhr": "5.0.0-alpha.36",
+    "@algolia/requester-node-http": "5.0.0-alpha.36"
+  },
+  "devDependencies": {
+    "@types/node": "16.11.59",
+    "rollup": "2.79.1",
+    "typescript": "4.8.3"
+  },
+  "engines": {
+    "node": ">= 14.0.0"
+  }
+}