@algolia/ingestion 1.0.0-alpha.8 → 1.0.0-alpha.81

package/model/clientMethodProps.ts

@@ -1,18 +1,96 @@
-// 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 { 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 { 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.
+   * The authentication UUID.
    */
   authenticationID: string;
 };
@@ -22,7 +100,7 @@ export type DeleteAuthenticationProps = {
  */
 export type DeleteDestinationProps = {
   /**
-   * The destination uuid.
+   * The destination UUID.
    */
   destinationID: string;
 };
@@ -32,7 +110,7 @@ export type DeleteDestinationProps = {
  */
 export type DeleteSourceProps = {
   /**
-   * The source uuid.
+   * The source UUID.
    */
   sourceID: string;
 };
@@ -42,7 +120,7 @@ export type DeleteSourceProps = {
  */
 export type DeleteTaskProps = {
   /**
-   * The task uuid.
+   * The task UUID.
    */
   taskID: string;
 };
@@ -52,7 +130,7 @@ export type DeleteTaskProps = {
  */
 export type DisableTaskProps = {
   /**
-   * The task uuid.
+   * The task UUID.
    */
   taskID: string;
 };
@@ -62,7 +140,7 @@ export type DisableTaskProps = {
  */
 export type EnableTaskProps = {
   /**
-   * The task uuid.
+   * The task UUID.
    */
   taskID: string;
 };
@@ -72,7 +150,7 @@ export type EnableTaskProps = {
  */
 export type GetAuthenticationProps = {
   /**
-   * The authentication uuid.
+   * The authentication UUID.
    */
   authenticationID: string;
 };
@@ -89,6 +167,22 @@ export type GetAuthenticationsProps = {
    * The page number to fetch, starting at 1.
    */
   page?: number;
+  /**
+   * The type of the authentications to retrieve.
+   */
+  type?: AuthenticationType[];
+  /**
+   * The platform of the authentications to retrieve.
+   */
+  platform?: PlatformWithNone[];
+  /**
+   * The key by which the list should be sorted.
+   */
+  sort?: AuthenticationSortKeys;
+  /**
+   * The order of the returned list.
+   */
+  order?: OrderKeys;
 };
 
 /**
@@ -96,7 +190,7 @@ export type GetAuthenticationsProps = {
  */
 export type GetDestinationProps = {
   /**
-   * The destination uuid.
+   * The destination UUID.
    */
   destinationID: string;
 };
@@ -113,6 +207,32 @@ export type GetDestinationsProps = {
    * The page number to fetch, starting at 1.
    */
   page?: number;
+  /**
+   * The type of the destinations to retrive.
+   */
+  type?: DestinationType[];
+  /**
+   * The authenticationIDs of the destinations to retrive.
+   */
+  authenticationID?: string[];
+  /**
+   * The key by which the list should be sorted.
+   */
+  sort?: DestinationSortKeys;
+  /**
+   * The order of the returned list.
+   */
+  order?: OrderKeys;
+};
+
+/**
+ * Properties for the `getDockerSourceStreams` method.
+ */
+export type GetDockerSourceStreamsProps = {
+  /**
+   * The source UUID.
+   */
+  sourceID: string;
 };
 
 /**
@@ -120,11 +240,11 @@ export type GetDestinationsProps = {
  */
 export type GetEventProps = {
   /**
-   * The run uuid.
+   * The run UUID.
    */
   runID: string;
   /**
-   * The event uuid.
+   * The event UUID.
    */
   eventID: string;
 };
@@ -134,7 +254,7 @@ export type GetEventProps = {
  */
 export type GetEventsProps = {
   /**
-   * The run uuid.
+   * The run UUID.
    */
   runID: string;
   /**
@@ -145,6 +265,30 @@ export type GetEventsProps = {
    * The page number to fetch, starting at 1.
    */
   page?: number;
+  /**
+   * Filter the status of the events.
+   */
+  status?: EventStatus[];
+  /**
+   * Filter the type of the events.
+   */
+  type?: EventType[];
+  /**
+   * The key by which the list should be sorted.
+   */
+  sort?: EventSortKeys;
+  /**
+   * The order of the returned list.
+   */
+  order?: OrderKeys;
+  /**
+   * The start date (in RFC3339 format) of the events fetching window. Defaults to \'now\'-3 hours if omitted.
+   */
+  startDate?: string;
+  /**
+   * The end date (in RFC3339 format) of the events fetching window. Defaults to \'now\' days if omitted.
+   */
+  endDate?: string;
 };
 
 /**
@@ -152,7 +296,7 @@ export type GetEventsProps = {
  */
 export type GetRunProps = {
   /**
-   * The run uuid.
+   * The run UUID.
    */
   runID: string;
 };
@@ -169,24 +313,30 @@ export type GetRunsProps = {
    * The page number to fetch, starting at 1.
    */
   page?: number;
-};
-
-/**
- * Properties for the `getRunsByTaskID` method.
- */
-export type GetRunsByTaskIDProps = {
   /**
-   * The task uuid.
+   * Filter the status of the runs.
    */
-  taskID: string;
+  status?: RunStatus[];
   /**
-   * The number of items per page to return.
+   * Filter by taskID.
    */
-  itemsPerPage?: number;
+  taskID?: string;
   /**
-   * The page number to fetch, starting at 1.
+   * The key by which the list should be sorted.
    */
-  page?: number;
+  sort?: RunSortKeys;
+  /**
+   * The order of the returned list.
+   */
+  order?: OrderKeys;
+  /**
+   * The start date (in RFC3339 format) of the runs fetching window. Defaults to \'now\'-7 days if omitted.
+   */
+  startDate?: string;
+  /**
+   * The end date (in RFC3339 format) of the runs fetching window. Defaults to \'now\' days if omitted.
+   */
+  endDate?: string;
 };
 
 /**
@@ -194,7 +344,7 @@ export type GetRunsByTaskIDProps = {
  */
 export type GetSourceProps = {
   /**
-   * The source uuid.
+   * The source UUID.
    */
   sourceID: string;
 };
@@ -211,6 +361,22 @@ export type GetSourcesProps = {
    * The page number to fetch, starting at 1.
    */
   page?: number;
+  /**
+   * The type of the sources to retrieve.
+   */
+  type?: SourceType[];
+  /**
+   * The authenticationIDs of the sources to retrieve. \'none\' returns sources that doesn\'t have an authentication.
+   */
+  authenticationID?: string[];
+  /**
+   * The key by which the list should be sorted.
+   */
+  sort?: SourceSortKeys;
+  /**
+   * The order of the returned list.
+   */
+  order?: OrderKeys;
 };
 
 /**
@@ -218,7 +384,7 @@ export type GetSourcesProps = {
  */
 export type GetTaskProps = {
   /**
-   * The task uuid.
+   * The task UUID.
    */
   taskID: string;
 };
@@ -236,21 +402,33 @@ export type GetTasksProps = {
    */
   page?: number;
   /**
-   * Which action the returned task should have. Can be a list of string separated with commas.
+   * The action of the tasks to retrieve.
    */
   action?: ActionType[];
   /**
-   * If the returned task should have its \'enabled\' property set to true.
+   * Whether the task is enabled or not.
    */
   enabled?: boolean;
   /**
-   * Which destinationID the returned task should have. Can be a list of string separated with commas.
+   * The sourceIDs of the tasks to retrieve.
+   */
+  sourceID?: string[];
+  /**
+   * The destinationIDs of the tasks to retrieve.
    */
   destinationID?: string[];
   /**
-   * Which trigger type the returned task should have. Can be a list of string separated with commas.
+   * The trigger type of the task.
    */
   triggerType?: TriggerType[];
+  /**
+   * The key by which the list should be sorted.
+   */
+  sort?: TaskSortKeys;
+  /**
+   * The order of the returned list.
+   */
+  order?: OrderKeys;
 };
 
 /**
@@ -258,17 +436,27 @@ export type GetTasksProps = {
  */
 export type RunTaskProps = {
   /**
-   * The task uuid.
+   * The task UUID.
    */
   taskID: string;
 };
 
+/**
+ * Properties for the `triggerDockerSourceDiscover` method.
+ */
+export type TriggerDockerSourceDiscoverProps = {
+  /**
+   * The source UUID.
+   */
+  sourceID: string;
+};
+
 /**
  * Properties for the `updateAuthentication` method.
  */
 export type UpdateAuthenticationProps = {
   /**
-   * The authentication uuid.
+   * The authentication UUID.
    */
   authenticationID: string;
   authenticationUpdate: AuthenticationUpdate;
@@ -279,7 +467,7 @@ export type UpdateAuthenticationProps = {
  */
 export type UpdateDestinationProps = {
   /**
-   * The destination uuid.
+   * The destination UUID.
    */
   destinationID: string;
   destinationUpdate: DestinationUpdate;
@@ -290,7 +478,7 @@ export type UpdateDestinationProps = {
  */
 export type UpdateSourceProps = {
   /**
-   * The source uuid.
+   * The source UUID.
    */
   sourceID: string;
   sourceUpdate: SourceUpdate;
@@ -301,7 +489,7 @@ export type UpdateSourceProps = {
  */
 export type UpdateTaskProps = {
   /**
-   * The task uuid.
+   * The task UUID.
    */
   taskID: string;
   taskUpdate: TaskUpdate;

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 index in the records (see 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,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.
 
 export type DeleteResponse = {
   /**

package/model/destination.ts

@@ -1,13 +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 { DestinationInput } from './destinationInput';
 import type { DestinationType } from './destinationType';
 
+/**
+ * A destination describe how the data is indexed on the Algolia side.
+ */
 export type Destination = {
+  /**
+   * The destination UUID.
+   */
   destinationID: string;
 
   type: DestinationType;
 
+  /**
+   * An human readable name describing the object.
+   */
   name: string;
 
   input: DestinationInput;
@@ -22,5 +31,8 @@ export type Destination = {
    */
   updatedAt?: string;
 
+  /**
+   * The authentication UUID.
+   */
   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';
 
+/**
+ * The payload when creating a destination.
+ */
 export type DestinationCreate = {
   type: DestinationType;
 
+  /**
+   * An human readable name describing the object.
+   */
   name: string;
 
   input: DestinationInput;
 
-  authenticationID: string;
+  /**
+   * The authentication UUID.
+   */
+  authenticationID?: string;
 };

package/model/destinationCreateResponse.ts

@@ -1,8 +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.
 
+/**
+ * Response from the API when the Destination is successfully created.
+ */
 export type DestinationCreateResponse = {
+  /**
+   * The destination UUID.
+   */
   destinationID: string;
 
+  /**
+   * An human readable name describing the object.
+   */
   name: 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 = {
+  /**
+   * The index name to store data in.
+   */
   indexName: string;
+
+  recordType?: RecordType;
+
+  /**
+   * Determines the attributes to exclude from an Algolia record. To remove nested element, you can separate the path to the element with dots (`.`):   - \"foo.bar\": will remove `bar` from `foo`. To remove elements from an array, you can use the following:   - \"foo.[0].bar\": will only remove `bar` from the first element of `foo`.   - \"foo.[*].bar\": will remove `bar` from every elements of `foo`.
+   */
+  attributesToExclude?: string[];
 };

package/model/destinationIndexPrefix.ts

@@ -1,5 +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 DestinationIndexPrefix = {
+  /**
+   * The prefix of the final index name.
+   */
   indexPrefix: string;
 };

package/model/destinationInput.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 { DestinationIndexName } from './destinationIndexName';
 import type { DestinationIndexPrefix } from './destinationIndexPrefix';

package/model/destinationSearch.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.
+
+/**
+ * Payload to search for multiple destinations, based on the given `destinationIDs`.
+ */
+export type DestinationSearch = {
+  destinationIDs: string[];
+};

package/model/destinationSortKeys.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.
+
+/**
+ * Used to sort the Destination list endpoint.
+ */
+export type DestinationSortKeys = 'createdAt' | 'name' | 'type' | 'updatedAt';

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';
+/**
+ * Type of the Destination, defines in which Algolia product the data will be stored.
+ */
+export type DestinationType = 'flow' | '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';
 
+/**
+ * Payload to partially update a Destination.
+ */
 export type DestinationUpdate = {
   type?: DestinationType;
 
+  /**
+   * An human readable name describing the object.
+   */
   name?: string;
 
   input?: DestinationInput;
 
+  /**
+   * The authentication UUID.
+   */
   authenticationID?: string;
 };

package/model/destinationUpdateResponse.ts

@@ -1,8 +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.
 
+/**
+ * Response from the API when the Destination is successfully updated.
+ */
 export type DestinationUpdateResponse = {
+  /**
+   * The destination UUID.
+   */
   destinationID: string;
 
+  /**
+   * An human readable name describing the object.
+   */
   name: 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.
+
+/**
+ * The type of the image.
+ */
+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.
+
+/**
+ * The registry where the image is stored.
+ */
+export type DockerRegistry = 'dockerhub' | 'ghcr';