chore: generated code for commit c917710b. [skip ci]

algolia/api-clients-automation@c917710

Co-authored-by: algolia-bot <[email protected]>
Co-authored-by: Clément Vannicatte <[email protected]>

Author: algolia-bot

packages/algoliasearch-lite/model/baseIndexSettings.ts

@@ -27,10 +27,6 @@ export type BaseIndexSettings = {
    * Sets the languages at the index level for language-specific processing such as tokenization and normalization.
    */
   indexLanguages?: string[];
-  /**
-   * Whether promoted results should match the filters of the current search, except for geographic filters.
-   */
-  filterPromotes?: boolean;
   /**
    * List of attributes on which you want to disable prefix matching.
    */
@@ -43,6 +39,14 @@ export type BaseIndexSettings = {
    * List of numeric attributes that can be used as numerical filters.
    */
   numericAttributesForFiltering?: string[];
+  /**
+   * Control which separators are indexed.
+   */
+  separatorsToIndex?: string;
+  /**
+   * The complete list of attributes used for searching.
+   */
+  searchableAttributes?: string[];
   /**
    * Lets you store custom data in your indices.
    */

packages/algoliasearch-lite/model/ignorePlurals.ts

@@ -0,0 +1,4 @@
+/**
+ * Treats singular, plurals, and other forms of declensions as matching terms. IgnorePlurals is used in conjunction with the queryLanguages setting. List: language ISO codes for which ignoring plurals should be enabled. This list will override any values that you may have set in queryLanguages. True: enables the ignore plurals functionality, where singulars and plurals are considered equivalent (foot = feet). The languages supported here are either every language (this is the default, see list of languages below), or those set by queryLanguages. False: disables ignore plurals, where singulars and plurals are not considered the same for matching purposes (foot will not find feet).
+ */
+export type IgnorePlurals = string[] | boolean;

packages/algoliasearch-lite/model/index.ts

@@ -33,6 +33,7 @@ export * from './facetsStats';
 export * from './fetchedIndex';
 export * from './highlightResult';
 export * from './hit';
+export * from './ignorePlurals';
 export * from './indexSettings';
 export * from './indexSettingsAsSearchParams';
 export * from './key';
@@ -50,6 +51,7 @@ export * from './promote';
 export * from './queryType';
 export * from './rankingInfo';
 export * from './reRankingApplyFilter';
+export * from './removeStopWords';
 export * from './removeWordsIfNoResults';
 export * from './rule';
 export * from './scopeType';

packages/algoliasearch-lite/model/indexSettingsAsSearchParams.ts

@@ -1,15 +1,13 @@
 import type { AdvancedSyntaxFeatures } from './advancedSyntaxFeatures';
 import type { AlternativesAsExact } from './alternativesAsExact';
 import type { ExactOnSingleWordQuery } from './exactOnSingleWordQuery';
+import type { IgnorePlurals } from './ignorePlurals';
 import type { QueryType } from './queryType';
+import type { RemoveStopWords } from './removeStopWords';
 import type { RemoveWordsIfNoResults } from './removeWordsIfNoResults';
 import type { TypoTolerance } from './typoTolerance';
 
 export type IndexSettingsAsSearchParams = {
-  /**
-   * The complete list of attributes used for searching.
-   */
-  searchableAttributes?: string[];
   /**
    * The complete list of attributes that will be used for faceting.
    */
@@ -83,18 +81,8 @@ export type IndexSettingsAsSearchParams = {
    * List of attributes on which you want to disable typo tolerance.
    */
   disableTypoToleranceOnAttributes?: string[];
-  /**
-   * Control which separators are indexed.
-   */
-  separatorsToIndex?: string;
-  /**
-   * Treats singular, plurals, and other forms of declensions as matching terms.
-   */
-  ignorePlurals?: string;
-  /**
-   * Removes stop (common) words from the query before executing it.
-   */
-  removeStopWords?: string;
+  ignorePlurals?: IgnorePlurals;
+  removeStopWords?: RemoveStopWords;
   /**
    * List of characters that the engine shouldn\'t automatically normalize.
    */

packages/algoliasearch-lite/model/removeStopWords.ts

@@ -0,0 +1,4 @@
+/**
+ * Removes stop (common) words from the query before executing it. RemoveStopWords is used in conjunction with the queryLanguages setting. List: language ISO codes for which ignoring plurals should be enabled. This list will override any values that you may have set in queryLanguages. True: enables the stop word functionality, ensuring that stop words are removed from consideration in a search. The languages supported here are either every language, or those set by queryLanguages. False: disables stop word functionality, allowing stop words to be taken into account in a search.
+ */
+export type RemoveStopWords = string[] | boolean;

packages/client-search/model/baseIndexSettings.ts

@@ -27,10 +27,6 @@ export type BaseIndexSettings = {
    * Sets the languages at the index level for language-specific processing such as tokenization and normalization.
    */
   indexLanguages?: string[];
-  /**
-   * Whether promoted results should match the filters of the current search, except for geographic filters.
-   */
-  filterPromotes?: boolean;
   /**
    * List of attributes on which you want to disable prefix matching.
    */
@@ -43,6 +39,14 @@ export type BaseIndexSettings = {
    * List of numeric attributes that can be used as numerical filters.
    */
   numericAttributesForFiltering?: string[];
+  /**
+   * Control which separators are indexed.
+   */
+  separatorsToIndex?: string;
+  /**
+   * The complete list of attributes used for searching.
+   */
+  searchableAttributes?: string[];
   /**
    * Lets you store custom data in your indices.
    */

packages/client-search/model/ignorePlurals.ts

@@ -0,0 +1,4 @@
+/**
+ * Treats singular, plurals, and other forms of declensions as matching terms. IgnorePlurals is used in conjunction with the queryLanguages setting. List: language ISO codes for which ignoring plurals should be enabled. This list will override any values that you may have set in queryLanguages. True: enables the ignore plurals functionality, where singulars and plurals are considered equivalent (foot = feet). The languages supported here are either every language (this is the default, see list of languages below), or those set by queryLanguages. False: disables ignore plurals, where singulars and plurals are not considered the same for matching purposes (foot will not find feet).
+ */
+export type IgnorePlurals = string[] | boolean;

packages/client-search/model/index.ts

@@ -54,6 +54,7 @@ export * from './getTaskResponse';
 export * from './getTopUserIdsResponse';
 export * from './highlightResult';
 export * from './hit';
+export * from './ignorePlurals';
 export * from './indexSettings';
 export * from './indexSettingsAsSearchParams';
 export * from './key';
@@ -80,6 +81,7 @@ export * from './promote';
 export * from './queryType';
 export * from './rankingInfo';
 export * from './reRankingApplyFilter';
+export * from './removeStopWords';
 export * from './removeUserIdResponse';
 export * from './removeWordsIfNoResults';
 export * from './replaceSourceResponse';

packages/client-search/model/indexSettingsAsSearchParams.ts

@@ -1,15 +1,13 @@
 import type { AdvancedSyntaxFeatures } from './advancedSyntaxFeatures';
 import type { AlternativesAsExact } from './alternativesAsExact';
 import type { ExactOnSingleWordQuery } from './exactOnSingleWordQuery';
+import type { IgnorePlurals } from './ignorePlurals';
 import type { QueryType } from './queryType';
+import type { RemoveStopWords } from './removeStopWords';
 import type { RemoveWordsIfNoResults } from './removeWordsIfNoResults';
 import type { TypoTolerance } from './typoTolerance';
 
 export type IndexSettingsAsSearchParams = {
-  /**
-   * The complete list of attributes used for searching.
-   */
-  searchableAttributes?: string[];
   /**
    * The complete list of attributes that will be used for faceting.
    */
@@ -83,18 +81,8 @@ export type IndexSettingsAsSearchParams = {
    * List of attributes on which you want to disable typo tolerance.
    */
   disableTypoToleranceOnAttributes?: string[];
-  /**
-   * Control which separators are indexed.
-   */
-  separatorsToIndex?: string;
-  /**
-   * Treats singular, plurals, and other forms of declensions as matching terms.
-   */
-  ignorePlurals?: string;
-  /**
-   * Removes stop (common) words from the query before executing it.
-   */
-  removeStopWords?: string;
+  ignorePlurals?: IgnorePlurals;
+  removeStopWords?: RemoveStopWords;
   /**
    * List of characters that the engine shouldn\'t automatically normalize.
    */

packages/client-search/model/removeStopWords.ts

@@ -0,0 +1,4 @@
+/**
+ * Removes stop (common) words from the query before executing it. RemoveStopWords is used in conjunction with the queryLanguages setting. List: language ISO codes for which ignoring plurals should be enabled. This list will override any values that you may have set in queryLanguages. True: enables the stop word functionality, ensuring that stop words are removed from consideration in a search. The languages supported here are either every language, or those set by queryLanguages. False: disables stop word functionality, allowing stop words to be taken into account in a search.
+ */
+export type RemoveStopWords = string[] | boolean;

packages/recommend/model/ignorePlurals.ts

@@ -0,0 +1,4 @@
+/**
+ * Treats singular, plurals, and other forms of declensions as matching terms. IgnorePlurals is used in conjunction with the queryLanguages setting. List: language ISO codes for which ignoring plurals should be enabled. This list will override any values that you may have set in queryLanguages. True: enables the ignore plurals functionality, where singulars and plurals are considered equivalent (foot = feet). The languages supported here are either every language (this is the default, see list of languages below), or those set by queryLanguages. False: disables ignore plurals, where singulars and plurals are not considered the same for matching purposes (foot will not find feet).
+ */
+export type IgnorePlurals = string[] | boolean;

packages/recommend/model/index.ts

@@ -14,6 +14,7 @@ export * from './facetsStats';
 export * from './getRecommendationsParams';
 export * from './getRecommendationsResponse';
 export * from './highlightResult';
+export * from './ignorePlurals';
 export * from './indexSettingsAsSearchParams';
 export * from './matchLevel';
 export * from './matchedGeoLocation';
@@ -29,6 +30,7 @@ export * from './recommendationModels';
 export * from './recommendationRequest';
 export * from './recommendationsRequest';
 export * from './recommendationsResponse';
+export * from './removeStopWords';
 export * from './removeWordsIfNoResults';
 export * from './searchParamsObject';
 export * from './snippetResult';

packages/recommend/model/indexSettingsAsSearchParams.ts

@@ -1,15 +1,13 @@
 import type { AdvancedSyntaxFeatures } from './advancedSyntaxFeatures';
 import type { AlternativesAsExact } from './alternativesAsExact';
 import type { ExactOnSingleWordQuery } from './exactOnSingleWordQuery';
+import type { IgnorePlurals } from './ignorePlurals';
 import type { QueryType } from './queryType';
+import type { RemoveStopWords } from './removeStopWords';
 import type { RemoveWordsIfNoResults } from './removeWordsIfNoResults';
 import type { TypoTolerance } from './typoTolerance';
 
 export type IndexSettingsAsSearchParams = {
-  /**
-   * The complete list of attributes used for searching.
-   */
-  searchableAttributes?: string[];
   /**
    * The complete list of attributes that will be used for faceting.
    */
@@ -83,18 +81,8 @@ export type IndexSettingsAsSearchParams = {
    * List of attributes on which you want to disable typo tolerance.
    */
   disableTypoToleranceOnAttributes?: string[];
-  /**
-   * Control which separators are indexed.
-   */
-  separatorsToIndex?: string;
-  /**
-   * Treats singular, plurals, and other forms of declensions as matching terms.
-   */
-  ignorePlurals?: string;
-  /**
-   * Removes stop (common) words from the query before executing it.
-   */
-  removeStopWords?: string;
+  ignorePlurals?: IgnorePlurals;
+  removeStopWords?: RemoveStopWords;
   /**
    * List of characters that the engine shouldn\'t automatically normalize.
    */

packages/recommend/model/removeStopWords.ts

@@ -0,0 +1,4 @@
+/**
+ * Removes stop (common) words from the query before executing it. RemoveStopWords is used in conjunction with the queryLanguages setting. List: language ISO codes for which ignoring plurals should be enabled. This list will override any values that you may have set in queryLanguages. True: enables the stop word functionality, ensuring that stop words are removed from consideration in a search. The languages supported here are either every language, or those set by queryLanguages. False: disables stop word functionality, allowing stop words to be taken into account in a search.
+ */
+export type RemoveStopWords = string[] | boolean;