refactor(specs): add interface to manipulate query parameter between composition API & Search API (generated)

algolia/api-clients-automation#5123

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

Author: 3 people

packages/client-composition/model/baseInjectionQueryParameters.ts

@@ -11,6 +11,7 @@ export * from './banner';
 export * from './bannerImage';
 export * from './bannerImageUrl';
 export * from './bannerLink';
+export * from './baseInjectionQueryParameters';
 export * from './baseSearchResponse';
 export * from './batchCompositionAction';
 export * from './batchParams';
@@ -50,7 +51,6 @@ export * from './ignorePlurals';
 export * from './injectedItem';
 export * from './injectedItemSource';
 export * from './injectedItemSourceSearch';
-export * from './injectedItemsQueryParameters';
 export * from './injection';
 export * from './insideBoundingBox';
 export * from './listCompositionsResponse';
@@ -62,7 +62,6 @@ export * from './multipleBatchRequest';
 export * from './multipleBatchResponse';
 export * from './numericFilters';
 export * from './optionalFilters';
-export * from './optionalWords';
 export * from './params';
 export * from './personalization';
 export * from './queryType';

packages/client-composition/model/index.ts

@@ -1,12 +1,12 @@
 // 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 { InjectedItemsQueryParameters } from './injectedItemsQueryParameters';
+import type { BaseInjectionQueryParameters } from './baseInjectionQueryParameters';
 
 export type InjectedItemSourceSearch = {
   /**
    * Composition Main Index name.
    */
   index: string;
 
-  params?: InjectedItemsQueryParameters | undefined;
+  params?: BaseInjectionQueryParameters | undefined;
 };

packages/client-composition/model/injectedItemSourceSearch.ts

@@ -25,7 +25,7 @@ export type Params = {
   page?: number | undefined;
 
   /**
-   * Whether the search response should include detailed ranking information.
+   * Whether the run response should include detailed ranking information.
    */
   getRankingInfo?: boolean | undefined;
 
@@ -69,22 +69,22 @@ export type Params = {
   insidePolygon?: Array<Array<number>> | undefined;
 
   /**
-   * Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection dictionaries.  This setting sets a default list of languages used by the `removeStopWords` and `ignorePlurals` settings. This setting also sets a dictionary for word detection in the logogram-based [CJK](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/#normalization-for-logogram-based-languages-cjk) languages. To support this, you must place the CJK language **first**.  **You should always specify a query language.** If you don\'t specify an indexing language, the search engine uses all [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/), or the languages you specified with the `ignorePlurals` or `removeStopWords` parameters. This can lead to unexpected search results. For more information, see [Language-specific configuration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/).
+   * Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection dictionaries This setting sets a default list of languages used by the `removeStopWords` and `ignorePlurals` settings. This setting also sets a dictionary for word detection in the logogram-based [CJK](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/#normalization-for-logogram-based-languages-cjk) languages. To support this, you must place the CJK language **first** **You should always specify a query language.** If you don\'t specify an indexing language, the search engine uses all [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/), or the languages you specified with the `ignorePlurals` or `removeStopWords` parameters. This can lead to unexpected search results. For more information, see [Language-specific configuration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/).
    */
   queryLanguages?: Array<SupportedLanguage> | undefined;
 
   /**
-   * ISO language codes that adjust settings that are useful for processing natural language queries (as opposed to keyword searches):  - Sets `removeStopWords` and `ignorePlurals` to the list of provided languages. - Sets `removeWordsIfNoResults` to `allOptional`. - Adds a `natural_language` attribute to `ruleContexts` and `analyticsTags`.
+   * ISO language codes that adjust settings that are useful for processing natural language queries (as opposed to keyword searches) - Sets `removeStopWords` and `ignorePlurals` to the list of provided languages. - Sets `removeWordsIfNoResults` to `allOptional`. - Adds a `natural_language` attribute to `ruleContexts` and `analyticsTags`.
    */
   naturalLanguages?: Array<SupportedLanguage> | undefined;
 
   /**
-   * Whether to enable rules.
+   * Whether to enable composition rules.
    */
   enableRules?: boolean | undefined;
 
   /**
-   * Assigns a rule context to the search query.  [Rule contexts](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/how-to/customize-search-results-by-platform/#whats-a-context) are strings that you can use to trigger matching rules.
+   * Assigns a rule context to the run query [Rule contexts](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/how-to/customize-search-results-by-platform/#whats-a-context) are strings that you can use to trigger matching rules.
    */
   ruleContexts?: Array<string> | undefined;
 
@@ -94,7 +94,7 @@ export type Params = {
   userToken?: string | undefined;
 
   /**
-   * Whether to include a `queryID` attribute in the response.  The query ID is a unique identifier for a search query and is required for tracking [click and conversion events](https://www.algolia.com/guides/sending-events/getting-started/).
+   * Whether to include a `queryID` attribute in the response The query ID is a unique identifier for a search query and is required for tracking [click and conversion events](https://www.algolia.com/guides/sending-events/getting-started/).
    */
   clickAnalytics?: boolean | undefined;
 
@@ -109,12 +109,12 @@ export type Params = {
   analyticsTags?: Array<string> | undefined;
 
   /**
-   * Whether to enable A/B testing for this search.
+   * Whether to enable index level A/B testing for this run request. If the composition mixes multiple indices, the A/B test is ignored.
    */
   enableABTest?: boolean | undefined;
 
   /**
-   * Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/).  This setting only has an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard.
+   * Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/) This setting only has an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard.
    */
   enableReRanking?: boolean | undefined;
 };

packages/client-composition/model/injectedItemsQueryParameters.ts

@@ -25,7 +25,7 @@ export type Params = {
   page?: number | undefined;
 
   /**
-   * Whether the search response should include detailed ranking information.
+   * Whether the run response should include detailed ranking information.
    */
   getRankingInfo?: boolean | undefined;
 
@@ -69,22 +69,22 @@ export type Params = {
   insidePolygon?: Array<Array<number>> | undefined;
 
   /**
-   * Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection dictionaries.  This setting sets a default list of languages used by the `removeStopWords` and `ignorePlurals` settings. This setting also sets a dictionary for word detection in the logogram-based [CJK](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/#normalization-for-logogram-based-languages-cjk) languages. To support this, you must place the CJK language **first**.  **You should always specify a query language.** If you don\'t specify an indexing language, the search engine uses all [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/), or the languages you specified with the `ignorePlurals` or `removeStopWords` parameters. This can lead to unexpected search results. For more information, see [Language-specific configuration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/).
+   * Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection dictionaries This setting sets a default list of languages used by the `removeStopWords` and `ignorePlurals` settings. This setting also sets a dictionary for word detection in the logogram-based [CJK](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/#normalization-for-logogram-based-languages-cjk) languages. To support this, you must place the CJK language **first** **You should always specify a query language.** If you don\'t specify an indexing language, the search engine uses all [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/), or the languages you specified with the `ignorePlurals` or `removeStopWords` parameters. This can lead to unexpected search results. For more information, see [Language-specific configuration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/).
    */
   queryLanguages?: Array<SupportedLanguage> | undefined;
 
   /**
-   * ISO language codes that adjust settings that are useful for processing natural language queries (as opposed to keyword searches):  - Sets `removeStopWords` and `ignorePlurals` to the list of provided languages. - Sets `removeWordsIfNoResults` to `allOptional`. - Adds a `natural_language` attribute to `ruleContexts` and `analyticsTags`.
+   * ISO language codes that adjust settings that are useful for processing natural language queries (as opposed to keyword searches) - Sets `removeStopWords` and `ignorePlurals` to the list of provided languages. - Sets `removeWordsIfNoResults` to `allOptional`. - Adds a `natural_language` attribute to `ruleContexts` and `analyticsTags`.
    */
   naturalLanguages?: Array<SupportedLanguage> | undefined;
 
   /**
-   * Whether to enable rules.
+   * Whether to enable composition rules.
    */
   enableRules?: boolean | undefined;
 
   /**
-   * Assigns a rule context to the search query.  [Rule contexts](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/how-to/customize-search-results-by-platform/#whats-a-context) are strings that you can use to trigger matching rules.
+   * Assigns a rule context to the run query [Rule contexts](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/how-to/customize-search-results-by-platform/#whats-a-context) are strings that you can use to trigger matching rules.
    */
   ruleContexts?: Array<string> | undefined;
 
@@ -94,7 +94,7 @@ export type Params = {
   userToken?: string | undefined;
 
   /**
-   * Whether to include a `queryID` attribute in the response.  The query ID is a unique identifier for a search query and is required for tracking [click and conversion events](https://www.algolia.com/guides/sending-events/getting-started/).
+   * Whether to include a `queryID` attribute in the response The query ID is a unique identifier for a search query and is required for tracking [click and conversion events](https://www.algolia.com/guides/sending-events/getting-started/).
    */
   clickAnalytics?: boolean | undefined;
 
@@ -109,12 +109,12 @@ export type Params = {
   analyticsTags?: Array<string> | undefined;
 
   /**
-   * Whether to enable A/B testing for this search.
+   * Whether to enable index level A/B testing for this run request. If the composition mixes multiple indices, the A/B test is ignored.
    */
   enableABTest?: boolean | undefined;
 
   /**
-   * Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/).  This setting only has an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard.
+   * Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/) This setting only has an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard.
    */
   enableReRanking?: boolean | undefined;
 };