@algolia/recommend 5.0.0-alpha.11 → 5.0.0-alpha.110

package/model/baseSearchParamsWithoutQuery.ts

@@ -1,20 +1,20 @@
-// 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 { AroundPrecision } from './aroundPrecision';
 import type { AroundRadius } from './aroundRadius';
 import type { FacetFilters } from './facetFilters';
 import type { NumericFilters } from './numericFilters';
 import type { OptionalFilters } from './optionalFilters';
-import type { ReRankingApplyFilter } from './reRankingApplyFilter';
 import type { TagFilters } from './tagFilters';
 
 export type BaseSearchParamsWithoutQuery = {
   /**
-   * Overrides the query parameter and performs a more generic search that can be used to find \"similar\" results.
+   * Keywords to be used instead of the search query to conduct a more broader search.  Using the `similarQuery` parameter changes other settings:  - `queryType` is set to `prefixNone`. - `removeStopWords` is set to true. - `words` is set as the first ranking criterion. - All remaining words are treated as `optionalWords`.  Since the `similarQuery` is supposed to do a broad search, they usually return many results. Combine it with `filters` to narrow down the list of results.
    */
   similarQuery?: string;
 
   /**
-   * Filter the query with numeric, facet and/or tag filters.
+   * Filter the search so that only records with matching values are included in the results.  These filters are supported:  - **Numeric filters.** `<facet> <op> <number>`, where `<op>` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`. - **Ranges.** `<facet>:<lower> TO <upper>` where `<lower>` and `<upper>` are the lower and upper limits of the range (inclusive). - **Facet filters.** `<facet>:<value>` where `<facet>` is a facet attribute (case-sensitive) and `<value>` a facet value. - **Tag filters.** `_tags:<value>` or just `<value>` (case-sensitive). - **Boolean filters.** `<facet>: true | false`.  You can combine filters with `AND`, `OR`, and `NOT` operators with the following restrictions:  - You can only combine filters of the same type with `OR`.   **Not supported:** `facet:value OR num > 3`. - You can\'t use `NOT` with combinations of filters.   **Not supported:** `NOT(facet:value OR facet:value)` - You can\'t combine conjunctions (`AND`) with `OR`.   **Not supported:** `facet:value OR (facet:value AND facet:value)`  Use quotes around your filters, if the facet attribute name or facet value has spaces, keywords (`OR`, `AND`, `NOT`), or quotes. If a facet attribute is an array, the filter matches if it matches at least one element of the array.  For more information, see [Filters](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/).
    */
   filters?: string;
 
@@ -27,131 +27,121 @@ export type BaseSearchParamsWithoutQuery = {
   tagFilters?: TagFilters;
 
   /**
-   * Determines how to calculate the total score for filtering.
+   * Whether to sum all filter scores.  If true, all filter scores are summed. Otherwise, the maximum filter score is kept. For more information, see [filter scores](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/in-depth/filter-scoring/#accumulating-scores-with-sumorfiltersscores).
    */
   sumOrFiltersScores?: boolean;
 
   /**
-   * Retrieve facets and their facet values.
+   * Restricts a search to a subset of your searchable attributes.
    */
-  facets?: string[];
+  restrictSearchableAttributes?: string[];
 
   /**
-   * Maximum number of facet values to return for each facet during a regular search.
+   * Facets for which to retrieve facet values that match the search criteria and the number of matching facet values.  To retrieve all facets, use the wildcard character `*`. For more information, see [facets](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts).
    */
-  maxValuesPerFacet?: number;
+  facets?: string[];
 
   /**
-   * Force faceting to be applied after de-duplication (via the Distinct setting).
+   * Whether faceting should be applied after deduplication with `distinct`.  This leads to accurate facet counts when using faceting in combination with `distinct`. It\'s usually better to use `afterDistinct` modifiers in the `attributesForFaceting` setting, as `facetingAfterDistinct` only computes correct facet counts if all records have the same facet values for the `attributeForDistinct`.
    */
   facetingAfterDistinct?: boolean;
 
   /**
-   * Controls how facet values are fetched.
-   */
-  sortFacetValuesBy?: string;
-
-  /**
-   * Specify the page to retrieve.
+   * Page of search results to retrieve.
    */
   page?: number;
 
   /**
-   * Specify the offset of the first hit to return.
+   * Position of the first hit to retrieve.
    */
   offset?: number;
 
   /**
-   * Set the number of hits to retrieve (used only with offset).
+   * Number of hits to retrieve (used in combination with `offset`).
    */
   length?: number;
 
   /**
-   * Search for entries around a central geolocation, enabling a geo search within a circular area.
+   * Coordinates for the center of a circle, expressed as a comma-separated string of latitude and longitude.  Only records included within circle around this central location are included in the results. The radius of the circle is determined by the `aroundRadius` and `minimumAroundRadius` settings. This parameter is ignored if you also specify `insidePolygon` or `insideBoundingBox`.
    */
   aroundLatLng?: string;
 
   /**
-   * Search for entries around a given location automatically computed from the requester\'s IP address.
+   * Whether to obtain the coordinates from the request\'s IP address.
    */
   aroundLatLngViaIP?: boolean;
 
   aroundRadius?: AroundRadius;
 
-  /**
-   * Precision of geo search (in meters), to add grouping by geo location to the ranking formula.
-   */
-  aroundPrecision?: number;
+  aroundPrecision?: AroundPrecision;
 
   /**
-   * Minimum radius (in meters) used for a geo search when aroundRadius is not set.
+   * Minimum radius (in meters) for a search around a location when `aroundRadius` isn\'t set.
    */
   minimumAroundRadius?: number;
 
   /**
-   * Search inside a rectangular area (in geo coordinates).
+   * Coordinates for a rectangular area in which to search.  Each bounding box is defined by the two opposite points of its diagonal, and expressed as latitude and longitude pair: `[p1 lat, p1 long, p2 lat, p2 long]`. Provide multiple bounding boxes as nested arrays. For more information, see [rectangular area](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas).
    */
-  insideBoundingBox?: number[];
+  insideBoundingBox?: number[][];
 
   /**
-   * Search inside a polygon (in geo coordinates).
+   * Coordinates of a polygon in which to search.  Polygons are defined by 3 to 10,000 points. Each point is represented by its latitude and longitude. Provide multiple polygons as nested arrays. For more information, see [filtering inside polygons](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas). This parameter is ignored, if you also specify `insideBoundingBox`.
    */
-  insidePolygon?: number[];
+  insidePolygon?: number[][];
 
   /**
-   * This parameter changes the default values of certain parameters and settings that work best for a natural language query, such as ignorePlurals, removeStopWords, removeWordsIfNoResults, analyticsTags and ruleContexts. These parameters and settings work well together when the query is formatted in natural language instead of keywords, for example when your user performs a voice search.
+   * 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?: string[];
 
   /**
-   * Enables contextual rules.
+   * 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.
    */
   ruleContexts?: string[];
 
   /**
-   * Define the impact of the Personalization feature.
+   * Impact that Personalization should have on this search.  The higher this value is, the more Personalization determines the ranking compared to other factors. For more information, see [Understanding Personalization impact](https://www.algolia.com/doc/guides/personalization/personalizing-results/in-depth/configuring-personalization/#understanding-personalization-impact).
    */
   personalizationImpact?: number;
 
   /**
-   * Associates a certain user token with the current search.
+   * Unique pseudonymous or anonymous user identifier.  This helps with analytics and click and conversion events. For more information, see [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
    */
   userToken?: string;
 
   /**
-   * Retrieve detailed ranking information.
+   * Whether the search response should include detailed ranking information.
    */
   getRankingInfo?: boolean;
 
   /**
-   * Enable the Click Analytics feature.
+   * Whether to take into account an index\'s synonyms for this search.
+   */
+  synonyms?: boolean;
+
+  /**
+   * 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;
 
   /**
-   * Whether the current query will be taken into account in the Analytics.
+   * Whether this search will be included in Analytics.
    */
   analytics?: boolean;
 
   /**
-   * List of tags to apply to the query for analytics purposes.
+   * Tags to apply to the query for [segmenting analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
    */
   analyticsTags?: string[];
 
   /**
-   * Whether to include or exclude a query from the processing-time percentile computation.
+   * Whether to include this search when calculating processing-time percentiles.
    */
   percentileComputation?: boolean;
 
   /**
-   * Whether this search should participate in running AB tests.
+   * Whether to enable A/B testing for this search.
    */
   enableABTest?: boolean;
-
-  /**
-   * Whether this search should use AI Re-Ranking.
-   */
-  enableReRanking?: boolean;
-
-  reRankingApplyFilter?: ReRankingApplyFilter | null;
 };

package/model/baseSearchResponse.ts

@@ -1,46 +1,50 @@
-// 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 { Exhaustive } from './exhaustive';
 import type { FacetsStats } from './facetsStats';
+import type { Redirect } from './redirect';
 import type { RenderingContent } from './renderingContent';
 
-export type BaseSearchResponse = {
+export type BaseSearchResponse = Record<string, any> & {
   /**
-   * If a search encounters an index that is being A/B tested, abTestID reports the ongoing A/B test ID.
+   * A/B test ID. This is only included in the response for indices that are part of an A/B test.
    */
   abTestID?: number;
 
   /**
-   * If a search encounters an index that is being A/B tested, abTestVariantID reports the variant ID of the index used (starting at 1).
+   * Variant ID. This is only included in the response for indices that are part of an A/B test.
    */
   abTestVariantID?: number;
 
   /**
-   * The computed geo location.
+   * Computed geographical location.
    */
   aroundLatLng?: string;
 
   /**
-   * The automatically computed radius. For legacy reasons, this parameter is a string and not an integer.
+   * Distance from a central coordinate provided by `aroundLatLng`.
    */
   automaticRadius?: string;
 
+  exhaustive?: Exhaustive;
+
   /**
-   * Whether the facet count is exhaustive or approximate.
+   * See the `facetsCount` field of the `exhaustive` object in the response.
    */
   exhaustiveFacetsCount?: boolean;
 
   /**
-   * Indicate if the nbHits count was exhaustive or approximate.
+   * See the `nbHits` field of the `exhaustive` object in the response.
    */
-  exhaustiveNbHits: boolean;
+  exhaustiveNbHits?: boolean;
 
   /**
-   * Indicate if the typo-tolerance search was exhaustive or approximate (only included when typo-tolerance is enabled).
+   * See the `typo` field of the `exhaustive` object in the response.
    */
   exhaustiveTypo?: boolean;
 
   /**
-   * A mapping of each facet name to the corresponding facet counts.
+   * Facet counts.
    */
   facets?: Record<string, Record<string, number>>;
 
@@ -50,7 +54,7 @@ export type BaseSearchResponse = {
   facets_stats?: Record<string, FacetsStats>;
 
   /**
-   * Set the number of hits per page.
+   * Number of hits per page.
    */
   hitsPerPage: number;
 
@@ -60,42 +64,37 @@ export type BaseSearchResponse = {
   index?: string;
 
   /**
-   * Index name used for the query. In the case of an A/B test, the targeted index isn\'t always the index used by the query.
+   * Index name used for the query. During A/B testing, the targeted index isn\'t always the index used by the query.
    */
   indexUsed?: string;
 
   /**
-   * Used to return warnings about the query.
+   * Warnings about the query.
    */
   message?: string;
 
   /**
-   * Number of hits that the search query matched.
+   * Number of results (hits).
    */
   nbHits: number;
 
   /**
-   * Number of pages available for the current query.
+   * Number of pages of results.
    */
   nbPages: number;
 
   /**
-   * The number of hits selected and sorted by the relevant sort algorithm.
+   * Number of hits selected and sorted by the relevant sort algorithm.
    */
   nbSortedHits?: number;
 
   /**
-   * Specify the page to retrieve.
+   * Page of search results to retrieve.
    */
   page: number;
 
   /**
-   * A url-encoded string of all search parameters.
-   */
-  params: string;
-
-  /**
-   * The query string that will be searched, after normalization.
+   * Post-[normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/#what-does-normalization-mean) query string that will be searched.
    */
   parsedQuery?: string;
 
@@ -105,24 +104,36 @@ export type BaseSearchResponse = {
   processingTimeMS: number;
 
   /**
-   * The text to search in the index.
+   * Experimental. List of processing steps and their times, in milliseconds. You can use this list to investigate performance issues.
    */
-  query: string;
+  processingTimingsMS?: Record<string, any>;
 
   /**
-   * A markup text indicating which parts of the original query have been removed in order to retrieve a non-empty result set.
+   * Markup text indicating which parts of the original query have been removed to retrieve a non-empty result set.
    */
   queryAfterRemoval?: string;
 
+  redirect?: Redirect;
+
+  renderingContent?: RenderingContent;
+
   /**
-   * Actual host name of the server that processed the request.
+   * Time the server took to process the request, in milliseconds.
+   */
+  serverTimeMS?: number;
+
+  /**
+   * Host name of the server that processed the request.
    */
   serverUsed?: string;
 
   /**
-   * Lets you store custom data in your indices.
+   * An object with custom data.  You can store up to 32&nbsp;kB as custom data.
    */
-  userData?: Record<string, any>;
+  userData?: any | null;
 
-  renderingContent?: RenderingContent;
+  /**
+   * Unique identifier for the query. This is used for [click analytics](https://www.algolia.com/doc/guides/analytics/click-analytics/).
+   */
+  queryID?: string;
 };

package/model/baseTrendingFacetsQuery.ts

@@ -0,0 +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 { TrendingFacetsModel } from './trendingFacetsModel';
+
+export type BaseTrendingFacetsQuery = {
+  /**
+   * Facet name for trending models.
+   */
+  facetName: string;
+
+  model?: TrendingFacetsModel;
+};

package/model/baseTrendingItemsQuery.ts

@@ -0,0 +1,22 @@
+// 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 { SearchParamsObject } from './searchParamsObject';
+import type { TrendingItemsModel } from './trendingItemsModel';
+
+export type BaseTrendingItemsQuery = {
+  /**
+   * Facet name for trending models.
+   */
+  facetName?: string;
+
+  /**
+   * Facet value for trending models.
+   */
+  facetValue?: string;
+
+  model?: TrendingItemsModel;
+
+  queryParameters?: SearchParamsObject;
+
+  fallbackParameters?: SearchParamsObject;
+};

package/model/clientMethodProps.ts

@@ -1,65 +1,137 @@
-// 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 { RecommendModels } from './recommendModels';
+import type { SearchRecommendRulesParams } from './searchRecommendRulesParams';
 
 /**
- * Properties for the `del` method.
+ * Properties for the `customDelete` method.
  */
-export type DelProps = {
+export type CustomDeleteProps = {
   /**
-   * The path of the API endpoint to target, anything after the /1 needs to be specified.
+   * Path of the endpoint, anything after \"/1\" must be specified.
    */
   path: string;
   /**
-   * Query parameters to be applied to the current query.
+   * Query parameters to apply to the current query.
    */
   parameters?: Record<string, any>;
 };
 
 /**
- * Properties for the `get` method.
+ * Properties for the `customGet` method.
  */
-export type GetProps = {
+export type CustomGetProps = {
   /**
-   * The path of the API endpoint to target, anything after the /1 needs to be specified.
+   * Path of the endpoint, anything after \"/1\" must be specified.
    */
   path: string;
   /**
-   * Query parameters to be applied to the current query.
+   * Query parameters to apply to the current query.
    */
   parameters?: Record<string, any>;
 };
 
 /**
- * Properties for the `post` method.
+ * Properties for the `customPost` method.
  */
-export type PostProps = {
+export type CustomPostProps = {
   /**
-   * The path of the API endpoint to target, anything after the /1 needs to be specified.
+   * Path of the endpoint, anything after \"/1\" must be specified.
    */
   path: string;
   /**
-   * Query parameters to be applied to the current query.
+   * Query parameters to apply to the current query.
    */
   parameters?: Record<string, any>;
   /**
-   * The parameters to send with the custom request.
+   * Parameters to send with the custom request.
    */
   body?: Record<string, any>;
 };
 
 /**
- * Properties for the `put` method.
+ * Properties for the `customPut` method.
  */
-export type PutProps = {
+export type CustomPutProps = {
   /**
-   * The path of the API endpoint to target, anything after the /1 needs to be specified.
+   * Path of the endpoint, anything after \"/1\" must be specified.
    */
   path: string;
   /**
-   * Query parameters to be applied to the current query.
+   * Query parameters to apply to the current query.
    */
   parameters?: Record<string, any>;
   /**
-   * The parameters to send with the custom request.
+   * Parameters to send with the custom request.
    */
   body?: Record<string, any>;
 };
+
+/**
+ * Properties for the `deleteRecommendRule` method.
+ */
+export type DeleteRecommendRuleProps = {
+  /**
+   * Name of the index on which to perform the operation.
+   */
+  indexName: string;
+  /**
+   * [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
+   */
+  model: RecommendModels;
+  /**
+   * Unique record identifier.
+   */
+  objectID: string;
+};
+
+/**
+ * Properties for the `getRecommendRule` method.
+ */
+export type GetRecommendRuleProps = {
+  /**
+   * Name of the index on which to perform the operation.
+   */
+  indexName: string;
+  /**
+   * [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
+   */
+  model: RecommendModels;
+  /**
+   * Unique record identifier.
+   */
+  objectID: string;
+};
+
+/**
+ * Properties for the `getRecommendStatus` method.
+ */
+export type GetRecommendStatusProps = {
+  /**
+   * Name of the index on which to perform the operation.
+   */
+  indexName: string;
+  /**
+   * [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
+   */
+  model: RecommendModels;
+  /**
+   * Unique identifier of a task. Numeric value (up to 64bits).
+   */
+  taskID: number;
+};
+
+/**
+ * Properties for the `searchRecommendRules` method.
+ */
+export type SearchRecommendRulesProps = {
+  /**
+   * Name of the index on which to perform the operation.
+   */
+  indexName: string;
+  /**
+   * [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
+   */
+  model: RecommendModels;
+  searchRecommendRulesParams?: SearchRecommendRulesParams;
+};

package/model/condition.ts

@@ -0,0 +1,27 @@
+// 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 { Anchoring } from './anchoring';
+
+export type Condition = {
+  /**
+   * Query pattern that triggers the rule.  You can use either a literal string, or a special pattern `{facet:ATTRIBUTE}`, where `ATTRIBUTE` is a facet name. The rule is triggered if the query matches the literal string or a value of the specified facet. For example, with `pattern: {facet:genre}`, the rule is triggered when users search for a genre, such as \"comedy\".
+   */
+  pattern?: string;
+
+  anchoring?: Anchoring;
+
+  /**
+   * Whether the pattern should match plurals, synonyms, and typos.
+   */
+  alternatives?: boolean;
+
+  /**
+   * An additional restriction that only triggers the rule, when the search has the same value as `ruleContexts` parameter. For example, if `context: mobile`, the rule is only triggered when the search request has a matching `ruleContexts: mobile`. A rule context must only contain alphanumeric characters.
+   */
+  context?: string;
+
+  /**
+   * Filters that trigger the rule.  You can add add filters using the syntax `facet:value` so that the rule is triggered, when the specific filter is selected. You can use `filters` on its own or combine it with the `pattern` parameter.
+   */
+  filters?: string;
+};

package/model/consequence.ts

@@ -0,0 +1,32 @@
+// 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 { ConsequenceHide } from './consequenceHide';
+import type { ConsequenceParams } from './consequenceParams';
+import type { Promote } from './promote';
+
+/**
+ * Effect of the rule.  For more information, see [Consequences](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/#consequences).
+ */
+export type Consequence = {
+  params?: ConsequenceParams;
+
+  /**
+   * Records you want to pin to a specific position in the search results.  You can promote up to 300 records, either individually, or as groups of up to 100 records each.
+   */
+  promote?: Promote[];
+
+  /**
+   * Whether promoted records must match an active filter for the consequence to be applied.  This ensures that user actions (filtering the search) are given a higher precendence. For example, if you promote a record with the `color: red` attribute, and the user filters the search for `color: blue`, the \"red\" record won\'t be shown.
+   */
+  filterPromotes?: boolean;
+
+  /**
+   * Records you want to hide from the search results.
+   */
+  hide?: ConsequenceHide[];
+
+  /**
+   * A JSON object with custom data that will be appended to the `userData` array in the response. This object isn\'t interpreted by the API and is limited to 1 kB of minified JSON.
+   */
+  userData?: any | null;
+};

package/model/consequenceHide.ts

@@ -0,0 +1,11 @@
+// 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.
+
+/**
+ * Object ID of the record to hide.
+ */
+export type ConsequenceHide = {
+  /**
+   * Unique record identifier.
+   */
+  objectID: string;
+};

package/model/consequenceParams.ts

@@ -0,0 +1,9 @@
+// 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 { BaseSearchParamsWithoutQuery } from './baseSearchParamsWithoutQuery';
+import type { IndexSettingsAsSearchParams } from './indexSettingsAsSearchParams';
+import type { Params } from './params';
+
+export type ConsequenceParams = BaseSearchParamsWithoutQuery &
+  IndexSettingsAsSearchParams &
+  Params;

package/model/consequenceQuery.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.
+
+import type { ConsequenceQueryObject } from './consequenceQueryObject';
+
+/**
+ * Replace or edit the search query.  If `consequenceQuery` is a string, the entire search query is replaced with that string. If `consequenceQuery` is an object, it describes incremental edits made to the query.
+ */
+export type ConsequenceQuery = ConsequenceQueryObject | string;