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

package/model/clientMethodProps.ts

@@ -1,18 +1,98 @@
-// 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 { ActionType } from './actionType';
+import type { AuthenticationSortKeys } from './authenticationSortKeys';
+import type { AuthenticationType } from './authenticationType';
 import type { AuthenticationUpdate } from './authenticationUpdate';
+import type { DestinationSortKeys } from './destinationSortKeys';
+import type { DestinationType } from './destinationType';
 import type { DestinationUpdate } from './destinationUpdate';
+import type { EventSortKeys } from './eventSortKeys';
+import type { EventStatus } from './eventStatus';
+import type { EventType } from './eventType';
+import type { OrderKeys } from './orderKeys';
+import type { PlatformWithNone } from './platformWithNone';
+import type { RunSortKeys } from './runSortKeys';
+import type { RunStatus } from './runStatus';
+import type { SortKeys } from './sortKeys';
+import type { SourceSortKeys } from './sourceSortKeys';
+import type { SourceType } from './sourceType';
 import type { SourceUpdate } from './sourceUpdate';
+import type { TaskSortKeys } from './taskSortKeys';
 import type { TaskUpdate } from './taskUpdate';
+import type { TransformationCreate } from './transformationCreate';
 import type { TriggerType } from './triggerType';
 
+/**
+ * Properties for the `customDelete` method.
+ */
+export type CustomDeleteProps = {
+  /**
+   * Path of the endpoint, anything after \"/1\" must be specified.
+   */
+  path: string;
+  /**
+   * Query parameters to apply to the current query.
+   */
+  parameters?: Record<string, any>;
+};
+
+/**
+ * Properties for the `customGet` method.
+ */
+export type CustomGetProps = {
+  /**
+   * Path of the endpoint, anything after \"/1\" must be specified.
+   */
+  path: string;
+  /**
+   * Query parameters to apply to the current query.
+   */
+  parameters?: Record<string, any>;
+};
+
+/**
+ * Properties for the `customPost` method.
+ */
+export type CustomPostProps = {
+  /**
+   * Path of the endpoint, anything after \"/1\" must be specified.
+   */
+  path: string;
+  /**
+   * Query parameters to apply to the current query.
+   */
+  parameters?: Record<string, any>;
+  /**
+   * Parameters to send with the custom request.
+   */
+  body?: Record<string, any>;
+};
+
+/**
+ * Properties for the `customPut` method.
+ */
+export type CustomPutProps = {
+  /**
+   * Path of the endpoint, anything after \"/1\" must be specified.
+   */
+  path: string;
+  /**
+   * Query parameters to apply to the current query.
+   */
+  parameters?: Record<string, any>;
+  /**
+   * Parameters to send with the custom request.
+   */
+  body?: Record<string, any>;
+};
+
 /**
  * Properties for the `deleteAuthentication` method.
  */
 export type DeleteAuthenticationProps = {
   /**
-   * The authentication uuid.
+   * Unique identifier of an authentication resource.
    */
   authenticationID: string;
 };
@@ -22,7 +102,7 @@ export type DeleteAuthenticationProps = {
  */
 export type DeleteDestinationProps = {
   /**
-   * The destination uuid.
+   * Unique identifier of a destination.
    */
   destinationID: string;
 };
@@ -32,7 +112,7 @@ export type DeleteDestinationProps = {
  */
 export type DeleteSourceProps = {
   /**
-   * The source uuid.
+   * Unique identifier of a source.
    */
   sourceID: string;
 };
@@ -42,17 +122,27 @@ export type DeleteSourceProps = {
  */
 export type DeleteTaskProps = {
   /**
-   * The task uuid.
+   * Unique identifier of a task.
    */
   taskID: string;
 };
 
+/**
+ * Properties for the `deleteTransformation` method.
+ */
+export type DeleteTransformationProps = {
+  /**
+   * Unique identifier of a transformation.
+   */
+  transformationID: string;
+};
+
 /**
  * Properties for the `disableTask` method.
  */
 export type DisableTaskProps = {
   /**
-   * The task uuid.
+   * Unique identifier of a task.
    */
   taskID: string;
 };
@@ -62,7 +152,7 @@ export type DisableTaskProps = {
  */
 export type EnableTaskProps = {
   /**
-   * The task uuid.
+   * Unique identifier of a task.
    */
   taskID: string;
 };
@@ -72,7 +162,7 @@ export type EnableTaskProps = {
  */
 export type GetAuthenticationProps = {
   /**
-   * The authentication uuid.
+   * Unique identifier of an authentication resource.
    */
   authenticationID: string;
 };
@@ -82,13 +172,29 @@ export type GetAuthenticationProps = {
  */
 export type GetAuthenticationsProps = {
   /**
-   * The number of items per page to return.
+   * Number of items per page.
    */
   itemsPerPage?: number;
   /**
-   * The page number to fetch, starting at 1.
+   * Page number of the paginated API response.
    */
   page?: number;
+  /**
+   * Type of authentication resource to retrieve.
+   */
+  type?: AuthenticationType[];
+  /**
+   * Ecommerce platform for which to retrieve authentication resources.
+   */
+  platform?: PlatformWithNone[];
+  /**
+   * Property by which to sort the list of authentication resources.
+   */
+  sort?: AuthenticationSortKeys;
+  /**
+   * Sort order of the response, ascending or descending.
+   */
+  order?: OrderKeys;
 };
 
 /**
@@ -96,7 +202,7 @@ export type GetAuthenticationsProps = {
  */
 export type GetDestinationProps = {
   /**
-   * The destination uuid.
+   * Unique identifier of a destination.
    */
   destinationID: string;
 };
@@ -106,13 +212,29 @@ export type GetDestinationProps = {
  */
 export type GetDestinationsProps = {
   /**
-   * The number of items per page to return.
+   * Number of items per page.
    */
   itemsPerPage?: number;
   /**
-   * The page number to fetch, starting at 1.
+   * Page number of the paginated API response.
    */
   page?: number;
+  /**
+   * Destination type.
+   */
+  type?: DestinationType[];
+  /**
+   * Authentication ID used by destinations.
+   */
+  authenticationID?: string[];
+  /**
+   * Property by which to sort the destinations.
+   */
+  sort?: DestinationSortKeys;
+  /**
+   * Sort order of the response, ascending or descending.
+   */
+  order?: OrderKeys;
 };
 
 /**
@@ -120,11 +242,11 @@ export type GetDestinationsProps = {
  */
 export type GetEventProps = {
   /**
-   * The run uuid.
+   * Unique identifier of a task run.
    */
   runID: string;
   /**
-   * The event uuid.
+   * Unique identifier of an event.
    */
   eventID: string;
 };
@@ -134,17 +256,41 @@ export type GetEventProps = {
  */
 export type GetEventsProps = {
   /**
-   * The run uuid.
+   * Unique identifier of a task run.
    */
   runID: string;
   /**
-   * The number of items per page to return.
+   * Number of items per page.
    */
   itemsPerPage?: number;
   /**
-   * The page number to fetch, starting at 1.
+   * Page number of the paginated API response.
    */
   page?: number;
+  /**
+   * Event status for filtering the list of task runs.
+   */
+  status?: EventStatus[];
+  /**
+   * Event type for filtering the list of task runs.
+   */
+  type?: EventType[];
+  /**
+   * Property by which to sort the list of task run events.
+   */
+  sort?: EventSortKeys;
+  /**
+   * Sort order of the response, ascending or descending.
+   */
+  order?: OrderKeys;
+  /**
+   * Date and time in RFC 3339 format for the earliest events to retrieve. By default, the current time minus three hours is used.
+   */
+  startDate?: string;
+  /**
+   * Date and time in RFC 3339 format for the latest events to retrieve. By default, the current time is used.
+   */
+  endDate?: string;
 };
 
 /**
@@ -152,7 +298,7 @@ export type GetEventsProps = {
  */
 export type GetRunProps = {
   /**
-   * The run uuid.
+   * Unique identifier of a task run.
    */
   runID: string;
 };
@@ -162,31 +308,37 @@ export type GetRunProps = {
  */
 export type GetRunsProps = {
   /**
-   * The number of items per page to return.
+   * Number of items per page.
    */
   itemsPerPage?: number;
   /**
-   * The page number to fetch, starting at 1.
+   * Page number of the paginated API response.
    */
   page?: number;
-};
-
-/**
- * Properties for the `getRunsByTaskID` method.
- */
-export type GetRunsByTaskIDProps = {
   /**
-   * The task uuid.
+   * Run status for filtering the list of task runs.
    */
-  taskID: string;
+  status?: RunStatus[];
   /**
-   * The number of items per page to return.
+   * Task ID for filtering the list of task runs.
    */
-  itemsPerPage?: number;
+  taskID?: string;
   /**
-   * The page number to fetch, starting at 1.
+   * Property by which to sort the list of task runs.
    */
-  page?: number;
+  sort?: RunSortKeys;
+  /**
+   * Sort order of the response, ascending or descending.
+   */
+  order?: OrderKeys;
+  /**
+   * Date in RFC 3339 format for the earliest run to retrieve. By default, the current day minus seven days is used.
+   */
+  startDate?: string;
+  /**
+   * Date in RFC 3339 format for the latest run to retrieve. By default, the current day is used.
+   */
+  endDate?: string;
 };
 
 /**
@@ -194,7 +346,7 @@ export type GetRunsByTaskIDProps = {
  */
 export type GetSourceProps = {
   /**
-   * The source uuid.
+   * Unique identifier of a source.
    */
   sourceID: string;
 };
@@ -204,13 +356,29 @@ export type GetSourceProps = {
  */
 export type GetSourcesProps = {
   /**
-   * The number of items per page to return.
+   * Number of items per page.
    */
   itemsPerPage?: number;
   /**
-   * The page number to fetch, starting at 1.
+   * Page number of the paginated API response.
    */
   page?: number;
+  /**
+   * Source type. Some sources require authentication.
+   */
+  type?: SourceType[];
+  /**
+   * Authentication IDs of the sources to retrieve. \'none\' returns sources that doesn\'t have an authentication resource.
+   */
+  authenticationID?: string[];
+  /**
+   * Property by which to sort the list of sources.
+   */
+  sort?: SourceSortKeys;
+  /**
+   * Sort order of the response, ascending or descending.
+   */
+  order?: OrderKeys;
 };
 
 /**
@@ -218,7 +386,7 @@ export type GetSourcesProps = {
  */
 export type GetTaskProps = {
   /**
-   * The task uuid.
+   * Unique identifier of a task.
    */
   taskID: string;
 };
@@ -228,29 +396,65 @@ export type GetTaskProps = {
  */
 export type GetTasksProps = {
   /**
-   * The number of items per page to return.
+   * Number of items per page.
    */
   itemsPerPage?: number;
   /**
-   * The page number to fetch, starting at 1.
+   * Page number of the paginated API response.
    */
   page?: number;
   /**
-   * Which action the returned task should have. Can be a list of string separated with commas.
+   * Actions for filtering the list of tasks.
    */
   action?: ActionType[];
   /**
-   * If the returned task should have its \'enabled\' property set to true.
+   * Whether to filter the list of tasks by the `enabled` status.
    */
   enabled?: boolean;
   /**
-   * Which destinationID the returned task should have. Can be a list of string separated with commas.
+   * Source IDs for filtering the list of tasks.
+   */
+  sourceID?: string[];
+  /**
+   * Destination IDs for filtering the list of tasks.
    */
   destinationID?: string[];
   /**
-   * Which trigger type the returned task should have. Can be a list of string separated with commas.
+   * Type of task trigger for filtering the list of tasks.
    */
   triggerType?: TriggerType[];
+  /**
+   * Property by which to sort the list of tasks.
+   */
+  sort?: TaskSortKeys;
+  /**
+   * Sort order of the response, ascending or descending.
+   */
+  order?: OrderKeys;
+};
+
+/**
+ * Properties for the `getTransformation` method.
+ */
+export type GetTransformationProps = {
+  /**
+   * Unique identifier of a transformation.
+   */
+  transformationID: string;
+};
+
+/**
+ * Properties for the `getTransformations` method.
+ */
+export type GetTransformationsProps = {
+  /**
+   * Property by which to sort the list.
+   */
+  sort?: SortKeys;
+  /**
+   * Sort order of the response, ascending or descending.
+   */
+  order?: OrderKeys;
 };
 
 /**
@@ -258,17 +462,27 @@ export type GetTasksProps = {
  */
 export type RunTaskProps = {
   /**
-   * The task uuid.
+   * Unique identifier of a task.
    */
   taskID: string;
 };
 
+/**
+ * Properties for the `triggerDockerSourceDiscover` method.
+ */
+export type TriggerDockerSourceDiscoverProps = {
+  /**
+   * Unique identifier of a source.
+   */
+  sourceID: string;
+};
+
 /**
  * Properties for the `updateAuthentication` method.
  */
 export type UpdateAuthenticationProps = {
   /**
-   * The authentication uuid.
+   * Unique identifier of an authentication resource.
    */
   authenticationID: string;
   authenticationUpdate: AuthenticationUpdate;
@@ -279,7 +493,7 @@ export type UpdateAuthenticationProps = {
  */
 export type UpdateDestinationProps = {
   /**
-   * The destination uuid.
+   * Unique identifier of a destination.
    */
   destinationID: string;
   destinationUpdate: DestinationUpdate;
@@ -290,7 +504,7 @@ export type UpdateDestinationProps = {
  */
 export type UpdateSourceProps = {
   /**
-   * The source uuid.
+   * Unique identifier of a source.
    */
   sourceID: string;
   sourceUpdate: SourceUpdate;
@@ -301,8 +515,30 @@ export type UpdateSourceProps = {
  */
 export type UpdateTaskProps = {
   /**
-   * The task uuid.
+   * Unique identifier of a task.
    */
   taskID: string;
   taskUpdate: TaskUpdate;
 };
+
+/**
+ * Properties for the `updateTransformation` method.
+ */
+export type UpdateTransformationProps = {
+  /**
+   * Unique identifier of a transformation.
+   */
+  transformationID: string;
+  transformationCreate: TransformationCreate;
+};
+
+/**
+ * Properties for the `validateSourceBeforeUpdate` method.
+ */
+export type ValidateSourceBeforeUpdateProps = {
+  /**
+   * Unique identifier of a source.
+   */
+  sourceID: string;
+  sourceUpdate: SourceUpdate;
+};

package/model/commercetoolsCustomFields.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.
+
+/**
+ * Custom fields from commercetools to add to the records.  For more information, see [Using Custom Types and Custom Fields](https://docs.commercetools.com/tutorials/custom-types).
+ */
+export type CommercetoolsCustomFields = {
+  /**
+   * Inventory custom fields.
+   */
+  inventory?: string[] | null;
+
+  /**
+   * Price custom fields.
+   */
+  price?: string[] | null;
+
+  /**
+   * Category custom fields.
+   */
+  category?: string[] | null;
+};

package/model/deleteResponse.ts

@@ -1,8 +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 DeleteResponse = {
   /**
-   * Date of deletion (RFC3339 format).
+   * Date of deletion in RFC 3339 format.
    */
   deletedAt: string;
 };

package/model/destination.ts

@@ -1,26 +1,38 @@
-// 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';
 
+/**
+ * Destinations are Algolia resources like indices or event streams.
+ */
 export type Destination = {
+  /**
+   * Universally unique identifier (UUID) of a destination resource.
+   */
   destinationID: string;
 
   type: DestinationType;
 
+  /**
+   * Descriptive name for the resource.
+   */
   name: string;
 
   input: DestinationInput;
 
   /**
-   * Date of creation (RFC3339 format).
+   * Date of creation in RFC 3339 format.
    */
   createdAt: string;
 
   /**
-   * Date of last update (RFC3339 format).
+   * Date of last update in RFC 3339 format.
    */
   updatedAt?: string;
 
+  /**
+   * Universally unique identifier (UUID) of an authentication resource.
+   */
   authenticationID?: string;
 };

package/model/destinationCreate.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 creating a new destination.
+ */
 export type DestinationCreate = {
   type: DestinationType;
 
+  /**
+   * Descriptive name for the resource.
+   */
   name: string;
 
   input: DestinationInput;
 
-  authenticationID: string;
+  /**
+   * Universally unique identifier (UUID) of an authentication resource.
+   */
+  authenticationID?: string;
 };

package/model/destinationCreateResponse.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 creating a new destination.
+ */
 export type DestinationCreateResponse = {
+  /**
+   * Universally unique identifier (UUID) of a destination resource.
+   */
   destinationID: string;
 
+  /**
+   * Descriptive name for the resource.
+   */
   name: string;
 
   /**
-   * Date of creation (RFC3339 format).
+   * Date of creation in RFC 3339 format.
    */
   createdAt: string;
 };

package/model/destinationIndexName.ts

@@ -1,5 +1,17 @@
-// 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 { RecordType } from './recordType';
 
 export type DestinationIndexName = {
+  /**
+   * Algolia index name (case-sensitive).
+   */
   indexName: string;
+
+  recordType?: RecordType;
+
+  /**
+   * Attributes from your source to exclude from Algolia records.  Not all your data attributes will be useful for searching. Keeping your Algolia records small increases indexing and search performance.  - Exclude nested attributes with `.` notation. For example, `foo.bar` indexes the `foo` attribute and all its children **except** the `bar` attribute. - Exclude attributes from arrays with `[i]`, where `i` is the index of the array element.   For example, `foo.[0].bar` only excludes the `bar` attribute from the first element of the `foo` array, but indexes the complete `foo` attribute for all other elements.   Use `*` as wildcard: `foo.[*].bar` excludes `bar` from all elements of the `foo` array.
+   */
+  attributesToExclude?: string[];
 };