@algolia/ingestion 1.0.0-alpha.83 → 1.0.0-alpha.84

package/dist/model/clientMethodProps.d.ts

@@ -83,7 +83,7 @@ export type CustomPutProps = {
  */
 export type DeleteAuthenticationProps = {
     /**
-     * The authentication UUID.
+     * Unique identifier of an authentication resource.
      */
     authenticationID: string;
 };
@@ -92,7 +92,7 @@ export type DeleteAuthenticationProps = {
  */
 export type DeleteDestinationProps = {
     /**
-     * The destination UUID.
+     * Unique identifier of a destination.
      */
     destinationID: string;
 };
@@ -101,7 +101,7 @@ export type DeleteDestinationProps = {
  */
 export type DeleteSourceProps = {
     /**
-     * The source UUID.
+     * Unique identifier of a source.
      */
     sourceID: string;
 };
@@ -110,7 +110,7 @@ export type DeleteSourceProps = {
  */
 export type DeleteTaskProps = {
     /**
-     * The task UUID.
+     * Unique identifier of a task.
      */
     taskID: string;
 };
@@ -119,7 +119,7 @@ export type DeleteTaskProps = {
  */
 export type DisableTaskProps = {
     /**
-     * The task UUID.
+     * Unique identifier of a task.
      */
     taskID: string;
 };
@@ -128,7 +128,7 @@ export type DisableTaskProps = {
  */
 export type EnableTaskProps = {
     /**
-     * The task UUID.
+     * Unique identifier of a task.
      */
     taskID: string;
 };
@@ -137,7 +137,7 @@ export type EnableTaskProps = {
  */
 export type GetAuthenticationProps = {
     /**
-     * The authentication UUID.
+     * Unique identifier of an authentication resource.
      */
     authenticationID: string;
 };
@@ -146,27 +146,27 @@ 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;
     /**
-     * The type of the authentications to retrieve.
+     * Type of authentication resource to retrieve.
      */
     type?: AuthenticationType[];
     /**
-     * The platform of the authentications to retrieve.
+     * Ecommerce platform for which to retrieve authentication resources.
      */
     platform?: PlatformWithNone[];
     /**
-     * The key by which the list should be sorted.
+     * Property by which to sort the list of authentication resources.
      */
     sort?: AuthenticationSortKeys;
     /**
-     * The order of the returned list.
+     * Sort order of the response, ascending or descending.
      */
     order?: OrderKeys;
 };
@@ -175,7 +175,7 @@ export type GetAuthenticationsProps = {
  */
 export type GetDestinationProps = {
     /**
-     * The destination UUID.
+     * Unique identifier of a destination.
      */
     destinationID: string;
 };
@@ -184,27 +184,27 @@ 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;
     /**
-     * The type of the destinations to retrive.
+     * Destination type.
      */
     type?: DestinationType[];
     /**
-     * The authenticationIDs of the destinations to retrive.
+     * Authentication ID used by destinations.
      */
     authenticationID?: string[];
     /**
-     * The key by which the list should be sorted.
+     * Property by which to sort the destinations.
      */
     sort?: DestinationSortKeys;
     /**
-     * The order of the returned list.
+     * Sort order of the response, ascending or descending.
      */
     order?: OrderKeys;
 };
@@ -213,7 +213,7 @@ export type GetDestinationsProps = {
  */
 export type GetDockerSourceStreamsProps = {
     /**
-     * The source UUID.
+     * Unique identifier of a source.
      */
     sourceID: string;
 };
@@ -222,11 +222,11 @@ export type GetDockerSourceStreamsProps = {
  */
 export type GetEventProps = {
     /**
-     * The run UUID.
+     * Unique identifier of a task run.
      */
     runID: string;
     /**
-     * The event UUID.
+     * Unique identifier of an event.
      */
     eventID: string;
 };
@@ -235,39 +235,39 @@ 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;
     /**
-     * Filter the status of the events.
+     * Event status for filtering the list of task runs.
      */
     status?: EventStatus[];
     /**
-     * Filter the type of the events.
+     * Event type for filtering the list of task runs.
      */
     type?: EventType[];
     /**
-     * The key by which the list should be sorted.
+     * Property by which to sort the list of task run events.
      */
     sort?: EventSortKeys;
     /**
-     * The order of the returned list.
+     * Sort order of the response, ascending or descending.
      */
     order?: OrderKeys;
     /**
-     * The start date (in RFC3339 format) of the events fetching window. Defaults to \'now\'-3 hours if omitted.
+     * Date and time in RFC3339 format for the earliest events to retrieve. By default, the current time minus three hours is used.
      */
     startDate?: string;
     /**
-     * The end date (in RFC3339 format) of the events fetching window. Defaults to \'now\' days if omitted.
+     * Date and time in RFC3339 format for the latest events to retrieve. By default, the current time is used.
      */
     endDate?: string;
 };
@@ -276,7 +276,7 @@ export type GetEventsProps = {
  */
 export type GetRunProps = {
     /**
-     * The run UUID.
+     * Unique identifier of a task run.
      */
     runID: string;
 };
@@ -285,35 +285,35 @@ 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;
     /**
-     * Filter the status of the runs.
+     * Run status for filtering the list of task runs.
      */
     status?: RunStatus[];
     /**
-     * Filter by taskID.
+     * Task ID for filtering the list of task runs.
      */
     taskID?: string;
     /**
-     * The key by which the list should be sorted.
+     * Property by which to sort the list of task runs.
      */
     sort?: RunSortKeys;
     /**
-     * The order of the returned list.
+     * Sort order of the response, ascending or descending.
      */
     order?: OrderKeys;
     /**
-     * The start date (in RFC3339 format) of the runs fetching window. Defaults to \'now\'-7 days if omitted.
+     * Date in RFC3339 format for the earliest run to retrieve. By default, the current day minus seven days is used.
      */
     startDate?: string;
     /**
-     * The end date (in RFC3339 format) of the runs fetching window. Defaults to \'now\' days if omitted.
+     * Date in RFC3339 format for the latest run to retrieve. By default, the current day is used.
      */
     endDate?: string;
 };
@@ -322,7 +322,7 @@ export type GetRunsProps = {
  */
 export type GetSourceProps = {
     /**
-     * The source UUID.
+     * Unique identifier of a source.
      */
     sourceID: string;
 };
@@ -331,27 +331,27 @@ 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;
     /**
-     * The type of the sources to retrieve.
+     * Source type. Some sources require authentication.
      */
     type?: SourceType[];
     /**
-     * The authenticationIDs of the sources to retrieve. \'none\' returns sources that doesn\'t have an authentication.
+     * Authentication IDs of the sources to retrieve. \'none\' returns sources that doesn\'t have an authentication resource.
      */
     authenticationID?: string[];
     /**
-     * The key by which the list should be sorted.
+     * Property by which to sort the list of sources.
      */
     sort?: SourceSortKeys;
     /**
-     * The order of the returned list.
+     * Sort order of the response, ascending or descending.
      */
     order?: OrderKeys;
 };
@@ -360,7 +360,7 @@ export type GetSourcesProps = {
  */
 export type GetTaskProps = {
     /**
-     * The task UUID.
+     * Unique identifier of a task.
      */
     taskID: string;
 };
@@ -369,39 +369,39 @@ 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;
     /**
-     * The action of the tasks to retrieve.
+     * Actions for filtering the list of tasks.
      */
     action?: ActionType[];
     /**
-     * Whether the task is enabled or not.
+     * Whether to filter the list of tasks by the `enabled` status.
      */
     enabled?: boolean;
     /**
-     * The sourceIDs of the tasks to retrieve.
+     * Source IDs for filtering the list of tasks.
      */
     sourceID?: string[];
     /**
-     * The destinationIDs of the tasks to retrieve.
+     * Destination IDs for filtering the list of tasks.
      */
     destinationID?: string[];
     /**
-     * The trigger type of the task.
+     * Type of task trigger for filtering the list of tasks.
      */
     triggerType?: TriggerType[];
     /**
-     * The key by which the list should be sorted.
+     * Property by which to sort the list of tasks.
      */
     sort?: TaskSortKeys;
     /**
-     * The order of the returned list.
+     * Sort order of the response, ascending or descending.
      */
     order?: OrderKeys;
 };
@@ -410,7 +410,7 @@ export type GetTasksProps = {
  */
 export type RunTaskProps = {
     /**
-     * The task UUID.
+     * Unique identifier of a task.
      */
     taskID: string;
 };
@@ -419,7 +419,7 @@ export type RunTaskProps = {
  */
 export type TriggerDockerSourceDiscoverProps = {
     /**
-     * The source UUID.
+     * Unique identifier of a source.
      */
     sourceID: string;
 };
@@ -428,7 +428,7 @@ export type TriggerDockerSourceDiscoverProps = {
  */
 export type UpdateAuthenticationProps = {
     /**
-     * The authentication UUID.
+     * Unique identifier of an authentication resource.
      */
     authenticationID: string;
     authenticationUpdate: AuthenticationUpdate;
@@ -438,7 +438,7 @@ export type UpdateAuthenticationProps = {
  */
 export type UpdateDestinationProps = {
     /**
-     * The destination UUID.
+     * Unique identifier of a destination.
      */
     destinationID: string;
     destinationUpdate: DestinationUpdate;
@@ -448,7 +448,7 @@ export type UpdateDestinationProps = {
  */
 export type UpdateSourceProps = {
     /**
-     * The source UUID.
+     * Unique identifier of a source.
      */
     sourceID: string;
     sourceUpdate: SourceUpdate;
@@ -458,7 +458,7 @@ export type UpdateSourceProps = {
  */
 export type UpdateTaskProps = {
     /**
-     * The task UUID.
+     * Unique identifier of a task.
      */
     taskID: string;
     taskUpdate: TaskUpdate;

package/dist/model/commercetoolsCustomFields.d.ts

@@ -1,5 +1,5 @@
 /**
- * Custom fields from Commercetools to index in the records (see https://docs.commercetools.com/tutorials/custom-types).
+ * 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 = {
     /**

package/dist/model/deleteResponse.d.ts

@@ -1,6 +1,6 @@
 export type DeleteResponse = {
     /**
-     * Date of deletion (RFC3339 format).
+     * Date of deletion in RFC3339 format.
      */
     deletedAt: string;
 };

package/dist/model/destination.d.ts

@@ -1,29 +1,29 @@
 import type { DestinationInput } from './destinationInput';
 import type { DestinationType } from './destinationType';
 /**
- * A destination describe how the data is indexed on the Algolia side.
+ * Destinations are Algolia resources like indices or event streams.
  */
 export type Destination = {
     /**
-     * The destination UUID.
+     * Universally unique identifier (UUID) of a destination resource.
      */
     destinationID: string;
     type: DestinationType;
     /**
-     * An human readable name describing the object.
+     * Descriptive name for the resource.
      */
     name: string;
     input: DestinationInput;
     /**
-     * Date of creation (RFC3339 format).
+     * Date of creation in RFC3339 format.
      */
     createdAt: string;
     /**
-     * Date of last update (RFC3339 format).
+     * Date of last update in RFC3339 format.
      */
     updatedAt?: string;
     /**
-     * The authentication UUID.
+     * Universally unique identifier (UUID) of an authentication resource.
      */
     authenticationID?: string;
 };

package/dist/model/destinationCreate.d.ts

@@ -1,17 +1,17 @@
 import type { DestinationInput } from './destinationInput';
 import type { DestinationType } from './destinationType';
 /**
- * The payload when creating a destination.
+ * API request body for creating a new destination.
  */
 export type DestinationCreate = {
     type: DestinationType;
     /**
-     * An human readable name describing the object.
+     * Descriptive name for the resource.
      */
     name: string;
     input: DestinationInput;
     /**
-     * The authentication UUID.
+     * Universally unique identifier (UUID) of an authentication resource.
      */
     authenticationID?: string;
 };

package/dist/model/destinationCreateResponse.d.ts

@@ -1,17 +1,17 @@
 /**
- * Response from the API when the Destination is successfully created.
+ * API response for creating a new destination.
  */
 export type DestinationCreateResponse = {
     /**
-     * The destination UUID.
+     * Universally unique identifier (UUID) of a destination resource.
      */
     destinationID: string;
     /**
-     * An human readable name describing the object.
+     * Descriptive name for the resource.
      */
     name: string;
     /**
-     * Date of creation (RFC3339 format).
+     * Date of creation in RFC3339 format.
      */
     createdAt: string;
 };

package/dist/model/destinationIndexName.d.ts

@@ -1,12 +1,12 @@
 import type { RecordType } from './recordType';
 export type DestinationIndexName = {
     /**
-     * The index name to store data in.
+     * Algolia index name.
      */
     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`.
+     * 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[];
 };

package/dist/model/destinationIndexPrefix.d.ts

@@ -1,6 +1,6 @@
 export type DestinationIndexPrefix = {
     /**
-     * The prefix of the final index name.
+     * String added to the beginning of all indices created by this destination.
      */
     indexPrefix: string;
 };

package/dist/model/destinationSearch.d.ts

@@ -1,5 +1,5 @@
 /**
- * Payload to search for multiple destinations, based on the given `destinationIDs`.
+ * API request body for searching destinations.
  */
 export type DestinationSearch = {
     destinationIDs: string[];

package/dist/model/destinationSortKeys.d.ts

@@ -1,5 +1,5 @@
 /**
- * Used to sort the Destination list endpoint.
+ * Property by which to sort the destinations.
  */
 export type DestinationSortKeys = 'createdAt' | 'name' | 'type' | 'updatedAt';
 //# sourceMappingURL=destinationSortKeys.d.ts.map

package/dist/model/destinationType.d.ts

@@ -1,5 +1,5 @@
 /**
- * Type of the Destination, defines in which Algolia product the data will be stored.
+ * Destination type.  <dl> <dt><code>search</code></dt> <dd>Data is stored in an Algolia index.</dd> <dt><code>insights</code></dt> <dd>Data is recorded as user events in the Insights API.</dd> </dl>.
  */
-export type DestinationType = 'flow' | 'insights' | 'search';
+export type DestinationType = 'insights' | 'search';
 //# sourceMappingURL=destinationType.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"destinationType.d.ts","sourceRoot":"","sources":["../../model/destinationType.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,GAAG,UAAU,GAAG,QAAQ,CAAC"}
+{"version":3,"file":"destinationType.d.ts","sourceRoot":"","sources":["../../model/destinationType.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,UAAU,GAAG,QAAQ,CAAC"}

package/dist/model/destinationUpdate.d.ts

@@ -1,17 +1,17 @@
 import type { DestinationInput } from './destinationInput';
 import type { DestinationType } from './destinationType';
 /**
- * Payload to partially update a Destination.
+ * API request body for updating a destination.
  */
 export type DestinationUpdate = {
     type?: DestinationType;
     /**
-     * An human readable name describing the object.
+     * Descriptive name for the resource.
      */
     name?: string;
     input?: DestinationInput;
     /**
-     * The authentication UUID.
+     * Universally unique identifier (UUID) of an authentication resource.
      */
     authenticationID?: string;
 };

package/dist/model/destinationUpdateResponse.d.ts

@@ -1,17 +1,17 @@
 /**
- * Response from the API when the Destination is successfully updated.
+ * API response for updating a destination.
  */
 export type DestinationUpdateResponse = {
     /**
-     * The destination UUID.
+     * Universally unique identifier (UUID) of a destination resource.
      */
     destinationID: string;
     /**
-     * An human readable name describing the object.
+     * Descriptive name for the resource.
      */
     name: string;
     /**
-     * Date of last update (RFC3339 format).
+     * Date of last update in RFC3339 format.
      */
     updatedAt: string;
 };

package/dist/model/dockerImageType.d.ts

@@ -1,5 +1,5 @@
 /**
- * The type of the image.
+ * Image type.
  */
 export type DockerImageType = 'airbyte' | 'custom' | 'singer';
 //# sourceMappingURL=dockerImageType.d.ts.map

package/dist/model/dockerRegistry.d.ts

@@ -1,5 +1,5 @@
 /**
- * The registry where the image is stored.
+ * Container registry name from where to pull the image.
  */
 export type DockerRegistry = 'dockerhub' | 'ghcr';
 //# sourceMappingURL=dockerRegistry.d.ts.map

package/dist/model/dockerSourceDiscover.d.ts

@@ -1,10 +1,10 @@
 export type DockerSourceDiscover = {
     /**
-     * The run UUID.
+     * Universally unique identifier (UUID) of a task run.
      */
     runID: string;
     /**
-     * Date of creation (RFC3339 format).
+     * Date of creation in RFC3339 format.
      */
     createdAt: string;
 };