@algolia/ingestion 1.0.0-alpha.2

package/model/clientMethodProps.ts

@@ -0,0 +1,290 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { AuthenticationUpdate } from './authenticationUpdate';
+import type { DestinationUpdate } from './destinationUpdate';
+import type { SourceUpdate } from './sourceUpdate';
+import type { TaskUpdate } from './taskUpdate';
+
+/**
+ * Properties for the `deleteAuthentication` method.
+ */
+export type DeleteAuthenticationProps = {
+  /**
+   * The authentication uuid.
+   */
+  authenticationID: string;
+};
+
+/**
+ * Properties for the `deleteDestination` method.
+ */
+export type DeleteDestinationProps = {
+  /**
+   * The destination uuid.
+   */
+  destinationID: string;
+};
+
+/**
+ * Properties for the `deleteSource` method.
+ */
+export type DeleteSourceProps = {
+  /**
+   * The source uuid.
+   */
+  sourceID: string;
+};
+
+/**
+ * Properties for the `deleteTask` method.
+ */
+export type DeleteTaskProps = {
+  /**
+   * The task uuid.
+   */
+  taskID: string;
+};
+
+/**
+ * Properties for the `disableTask` method.
+ */
+export type DisableTaskProps = {
+  /**
+   * The task uuid.
+   */
+  taskID: string;
+};
+
+/**
+ * Properties for the `enableTask` method.
+ */
+export type EnableTaskProps = {
+  /**
+   * The task uuid.
+   */
+  taskID: string;
+};
+
+/**
+ * Properties for the `getAuthentication` method.
+ */
+export type GetAuthenticationProps = {
+  /**
+   * The authentication uuid.
+   */
+  authenticationID: string;
+};
+
+/**
+ * Properties for the `getAuthentications` method.
+ */
+export type GetAuthenticationsProps = {
+  /**
+   * The number of items per page to return.
+   */
+  itemsPerPage?: number;
+  /**
+   * The page number to fetch, starting at 1.
+   */
+  page?: number;
+};
+
+/**
+ * Properties for the `getDestination` method.
+ */
+export type GetDestinationProps = {
+  /**
+   * The destination uuid.
+   */
+  destinationID: string;
+};
+
+/**
+ * Properties for the `getDestinations` method.
+ */
+export type GetDestinationsProps = {
+  /**
+   * The number of items per page to return.
+   */
+  itemsPerPage?: number;
+  /**
+   * The page number to fetch, starting at 1.
+   */
+  page?: number;
+};
+
+/**
+ * Properties for the `getEvent` method.
+ */
+export type GetEventProps = {
+  /**
+   * The run uuid.
+   */
+  runID: string;
+  /**
+   * The event uuid.
+   */
+  eventID: string;
+};
+
+/**
+ * Properties for the `getEvents` method.
+ */
+export type GetEventsProps = {
+  /**
+   * The run uuid.
+   */
+  runID: string;
+  /**
+   * The number of items per page to return.
+   */
+  itemsPerPage?: number;
+  /**
+   * The page number to fetch, starting at 1.
+   */
+  page?: number;
+};
+
+/**
+ * Properties for the `getRun` method.
+ */
+export type GetRunProps = {
+  /**
+   * The run uuid.
+   */
+  runID: string;
+};
+
+/**
+ * Properties for the `getRuns` method.
+ */
+export type GetRunsProps = {
+  /**
+   * The number of items per page to return.
+   */
+  itemsPerPage?: number;
+  /**
+   * The page number to fetch, starting at 1.
+   */
+  page?: number;
+};
+
+/**
+ * Properties for the `getRunsByTaskID` method.
+ */
+export type GetRunsByTaskIDProps = {
+  /**
+   * The task uuid.
+   */
+  taskID: string;
+  /**
+   * The number of items per page to return.
+   */
+  itemsPerPage?: number;
+  /**
+   * The page number to fetch, starting at 1.
+   */
+  page?: number;
+};
+
+/**
+ * Properties for the `getSource` method.
+ */
+export type GetSourceProps = {
+  /**
+   * The source uuid.
+   */
+  sourceID: string;
+};
+
+/**
+ * Properties for the `getSources` method.
+ */
+export type GetSourcesProps = {
+  /**
+   * The number of items per page to return.
+   */
+  itemsPerPage?: number;
+  /**
+   * The page number to fetch, starting at 1.
+   */
+  page?: number;
+};
+
+/**
+ * Properties for the `getTask` method.
+ */
+export type GetTaskProps = {
+  /**
+   * The task uuid.
+   */
+  taskID: string;
+};
+
+/**
+ * Properties for the `getTasks` method.
+ */
+export type GetTasksProps = {
+  /**
+   * The number of items per page to return.
+   */
+  itemsPerPage?: number;
+  /**
+   * The page number to fetch, starting at 1.
+   */
+  page?: number;
+};
+
+/**
+ * Properties for the `runTask` method.
+ */
+export type RunTaskProps = {
+  /**
+   * The task uuid.
+   */
+  taskID: string;
+};
+
+/**
+ * Properties for the `updateAuthentication` method.
+ */
+export type UpdateAuthenticationProps = {
+  /**
+   * The authentication uuid.
+   */
+  authenticationID: string;
+  authenticationUpdate: AuthenticationUpdate;
+};
+
+/**
+ * Properties for the `updateDestination` method.
+ */
+export type UpdateDestinationProps = {
+  /**
+   * The destination uuid.
+   */
+  destinationID: string;
+  destinationUpdate: DestinationUpdate;
+};
+
+/**
+ * Properties for the `updateSource` method.
+ */
+export type UpdateSourceProps = {
+  /**
+   * The source uuid.
+   */
+  sourceID: string;
+  sourceUpdate: SourceUpdate;
+};
+
+/**
+ * Properties for the `updateTask` method.
+ */
+export type UpdateTaskProps = {
+  /**
+   * The task uuid.
+   */
+  taskID: string;
+  taskUpdate: TaskUpdate;
+};

package/model/deleteResponse.ts

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

package/model/destination.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 { DestinationInput } from './destinationInput';
+import type { DestinationType } from './destinationType';
+
+export type Destination = {
+  destinationID: string;
+
+  type: DestinationType;
+
+  name: string;
+
+  input: DestinationInput;
+
+  /**
+   * Date of creation (RFC3339 format).
+   */
+  createdAt: string;
+
+  /**
+   * Date of last update (RFC3339 format).
+   */
+  updatedAt?: string;
+
+  authenticationID: string;
+};

package/model/destinationCreate.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 { DestinationInput } from './destinationInput';
+import type { DestinationType } from './destinationType';
+
+export type DestinationCreate = {
+  type: DestinationType;
+
+  name: string;
+
+  input: DestinationInput;
+
+  authenticationID: string;
+};

package/model/destinationCreateResponse.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 DestinationCreateResponse = {
+  destinationID: string;
+
+  name: string;
+
+  /**
+   * Date of creation (RFC3339 format).
+   */
+  createdAt: string;
+};

package/model/destinationIndexName.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 DestinationIndexName = {
+  indexName: string;
+};

package/model/destinationIndexPrefix.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 DestinationIndexPrefix = {
+  indexPrefix: string;
+};

package/model/destinationInput.ts

@@ -0,0 +1,6 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { DestinationIndexName } from './destinationIndexName';
+import type { DestinationIndexPrefix } from './destinationIndexPrefix';
+
+export type DestinationInput = DestinationIndexName | DestinationIndexPrefix;

package/model/destinationType.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 DestinationType = 'flow' | 'insights' | 'predict' | 'search';

package/model/destinationUpdate.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 { DestinationInput } from './destinationInput';
+import type { DestinationType } from './destinationType';
+
+export type DestinationUpdate = {
+  type?: DestinationType;
+
+  name?: string;
+
+  input?: DestinationInput;
+
+  authenticationID?: string;
+};

package/model/destinationUpdateResponse.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 DestinationUpdateResponse = {
+  destinationID: string;
+
+  name: string;
+
+  /**
+   * Date of last update (RFC3339 format).
+   */
+  updatedAt: string;
+};

package/model/errorBase.ts

@@ -0,0 +1,8 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+/**
+ * Error.
+ */
+export type ErrorBase = Record<string, any> & {
+  message?: string;
+};

package/model/event.ts

@@ -0,0 +1,23 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { EventStatus } from './eventStatus';
+import type { EventType } from './eventType';
+
+export type Event = {
+  eventID: string;
+
+  runID: string;
+
+  parentID?: string;
+
+  status: EventStatus;
+
+  type: EventType;
+
+  data?: Record<string, any>;
+
+  /**
+   * Date of publish (RFC3339 format).
+   */
+  publishedAt: string;
+};

package/model/eventStatus.ts

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

package/model/eventType.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 EventType = 'fetch' | 'internal' | 'record';

package/model/index.ts

@@ -0,0 +1,60 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export * from './actionType';
+export * from './authAPIKey';
+export * from './authAlgolia';
+export * from './authBasic';
+export * from './authGoogleServiceAccount';
+export * from './authInput';
+export * from './authOAuth';
+export * from './authentication';
+export * from './authenticationCreate';
+export * from './authenticationCreateResponse';
+export * from './authenticationType';
+export * from './authenticationUpdate';
+export * from './authenticationUpdateResponse';
+export * from './deleteResponse';
+export * from './destination';
+export * from './destinationCreate';
+export * from './destinationCreateResponse';
+export * from './destinationIndexName';
+export * from './destinationIndexPrefix';
+export * from './destinationInput';
+export * from './destinationType';
+export * from './destinationUpdate';
+export * from './destinationUpdateResponse';
+export * from './errorBase';
+export * from './event';
+export * from './eventStatus';
+export * from './eventType';
+export * from './listAuthenticationsResponse';
+export * from './listDestinationsResponse';
+export * from './listEventsResponse';
+export * from './listSourcesResponse';
+export * from './listTasksResponse';
+export * from './pagination';
+export * from './platformType';
+export * from './run';
+export * from './runListResponse';
+export * from './runOutcome';
+export * from './runProgress';
+export * from './runResponse';
+export * from './runStatus';
+export * from './runType';
+export * from './source';
+export * from './sourceBigCommerce';
+export * from './sourceCommercetools';
+export * from './sourceCreate';
+export * from './sourceCreateResponse';
+export * from './sourceInput';
+export * from './sourceType';
+export * from './sourceUpdate';
+export * from './sourceUpdateResponse';
+export * from './task';
+export * from './taskCreate';
+export * from './taskCreateResponse';
+export * from './taskUpdate';
+export * from './taskUpdateResponse';
+export * from './trigger';
+export * from './triggerType';
+export * from './clientMethodProps';

package/model/listAuthenticationsResponse.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 { Authentication } from './authentication';
+import type { Pagination } from './pagination';
+
+export type ListAuthenticationsResponse = {
+  authentications: Authentication[];
+
+  pagination: Pagination;
+};

package/model/listDestinationsResponse.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 { Destination } from './destination';
+import type { Pagination } from './pagination';
+
+export type ListDestinationsResponse = {
+  destinations: Destination[];
+
+  pagination: Pagination;
+};

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

package/model/listSourcesResponse.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 { Source } from './source';
+
+export type ListSourcesResponse = {
+  sources: Source[];
+
+  pagination: Pagination;
+};

package/model/listTasksResponse.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 { Task } from './task';
+
+export type ListTasksResponse = {
+  tasks: Task[];
+
+  pagination: Pagination;
+};

package/model/pagination.ts

@@ -0,0 +1,11 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export type Pagination = {
+  nbPages: number;
+
+  page: number;
+
+  nbItems: number;
+
+  itemsPerPage: number;
+};

package/model/platformType.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 PlatformType = 'bigcommerce' | 'commercetools';

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';