feat(specs): add Algolia Index as a native connector in ingestion client (generated)

algolia/api-clients-automation#6290

Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>
Co-authored-by: Morgan Leroi <morgan.leroi@gmail.com>

Author: algolia-bot

packages/algoliasearch/lite/src/liteClient.ts

@@ -247,11 +247,11 @@ export function createLiteClient({
     },
 
     /**
-     * Sends multiple search requests to one or more indices.  This can be useful in these cases:  - Different indices for different purposes, such as, one index for products, another one for marketing content. - Multiple searches to the same index—for example, with different filters.  Use the helper `searchForHits` or `searchForFacets` to get the results in a more convenient format, if you already know the return type you want.
+     * Runs multiple search queries against one or more indices in a single API request.  Use cases include:  - Searching different indices, such as products and marketing content. - Run multiple queries on the same index with different parameters or filters.  If you know the expected result type, use the `searchForHits` or `searchForFacets` helper to simplify the response format.
      *
      * Required API Key ACLs:
      *  - search
-     * @param searchMethodParams - Muli-search request body. Results are returned in the same order as the requests.
+     * @param searchMethodParams - Multi-query search request body. Results are returned in the same order as the requests.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     search<T>(

packages/client-search/src/searchClient.ts

@@ -2571,11 +2571,11 @@ export function createSearchClient({
     },
 
     /**
-     * Sends multiple search requests to one or more indices.  This can be useful in these cases:  - Different indices for different purposes, such as, one index for products, another one for marketing content. - Multiple searches to the same index—for example, with different filters.  Use the helper `searchForHits` or `searchForFacets` to get the results in a more convenient format, if you already know the return type you want.
+     * Runs multiple search queries against one or more indices in a single API request.  Use cases include:  - Searching different indices, such as products and marketing content. - Run multiple queries on the same index with different parameters or filters.  If you know the expected result type, use the `searchForHits` or `searchForFacets` helper to simplify the response format.
      *
      * Required API Key ACLs:
      *  - search
-     * @param searchMethodParams - Muli-search request body. Results are returned in the same order as the requests.
+     * @param searchMethodParams - Multi-query search request body. Results are returned in the same order as the requests.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     search<T>(

packages/composition/model/externalOrdering.ts

@@ -1,3 +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.
 
+/**
+ * Ordering to apply on the injected items coming from the external source. \'default\' means the items will be ordered as they are in the index (natural relevance) in the smart group. \'userDefined\' means the order in which the objectIDs are provided in the run request payload will be preserved in the smart group.
+ */
 export type ExternalOrdering = 'default' | 'userDefined';

packages/ingestion/model/index.ts

@@ -94,6 +94,7 @@ export * from './shopifyInput';
 export * from './shopifyMarket';
 export * from './shopifyMetafield';
 export * from './source';
+export * from './sourceAlgoliaIndex';
 export * from './sourceBigCommerce';
 export * from './sourceBigQuery';
 export * from './sourceCommercetools';
@@ -110,6 +111,7 @@ export * from './sourceShopifyBase';
 export * from './sourceSortKeys';
 export * from './sourceType';
 export * from './sourceUpdate';
+export * from './sourceUpdateAlgoliaIndex';
 export * from './sourceUpdateCommercetools';
 export * from './sourceUpdateDocker';
 export * from './sourceUpdateInput';

packages/ingestion/model/sourceAlgoliaIndex.ts

@@ -0,0 +1,16 @@
+// 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.
+
+/**
+ * Specific configuration attributes of an `algoliaIndex` source.
+ */
+export type SourceAlgoliaIndex = {
+  /**
+   * Name of the Algolia index to read records from.
+   */
+  indexName: string;
+
+  /**
+   * SQL-like filter expression applied while browsing the source index. See [filters](https://www.algolia.com/doc/api-reference/api-parameters/filters/).
+   */
+  filters?: string | undefined;
+};

packages/ingestion/model/sourceInput.ts

@@ -1,5 +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.
 
+import type { SourceAlgoliaIndex } from './sourceAlgoliaIndex';
 import type { SourceBigCommerce } from './sourceBigCommerce';
 import type { SourceBigQuery } from './sourceBigQuery';
 import type { SourceCSV } from './sourceCSV';
@@ -17,4 +18,5 @@ export type SourceInput =
   | SourceBigQuery
   | SourceGA4BigQueryExport
   | SourceDocker
-  | SourceShopify;
+  | SourceShopify
+  | SourceAlgoliaIndex;

packages/ingestion/model/sourceType.ts

@@ -1,6 +1,7 @@
 // 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 SourceType =
+  | 'algoliaIndex'
   | 'bigcommerce'
   | 'bigquery'
   | 'commercetools'

packages/ingestion/model/sourceUpdateAlgoliaIndex.ts

@@ -0,0 +1,16 @@
+// 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.
+
+/**
+ * Specific configuration attributes of an `algoliaIndex` source.
+ */
+export type SourceUpdateAlgoliaIndex = {
+  /**
+   * Name of the Algolia index to read records from.
+   */
+  indexName?: string | undefined;
+
+  /**
+   * SQL-like filter expression applied while browsing the source index. See [filters](https://www.algolia.com/doc/api-reference/api-parameters/filters/).
+   */
+  filters?: string | undefined;
+};

packages/ingestion/model/sourceUpdateInput.ts

@@ -4,6 +4,7 @@ import type { SourceBigQuery } from './sourceBigQuery';
 import type { SourceCSV } from './sourceCSV';
 import type { SourceGA4BigQueryExport } from './sourceGA4BigQueryExport';
 import type { SourceJSON } from './sourceJSON';
+import type { SourceUpdateAlgoliaIndex } from './sourceUpdateAlgoliaIndex';
 import type { SourceUpdateCommercetools } from './sourceUpdateCommercetools';
 import type { SourceUpdateDocker } from './sourceUpdateDocker';
 import type { SourceUpdateShopify } from './sourceUpdateShopify';
@@ -15,4 +16,5 @@ export type SourceUpdateInput =
   | SourceBigQuery
   | SourceGA4BigQueryExport
   | SourceUpdateDocker
-  | SourceUpdateShopify;
+  | SourceUpdateShopify
+  | SourceUpdateAlgoliaIndex;