@algolia/client-search 5.0.0-alpha.9 → 5.0.0-alpha.90

package/model/promote.ts

@@ -1,4 +1,4 @@
-// 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 { PromoteObjectID } from './promoteObjectID';
 import type { PromoteObjectIDs } from './promoteObjectIDs';

package/model/promoteObjectID.ts

@@ -1,16 +1,16 @@
-// 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.
 
 /**
- * Single objectID to promote as hits.
+ * Record to promote.
  */
 export type PromoteObjectID = {
   /**
-   * Unique identifier of the object to promote.
+   * Unique identifier of the record to promote.
    */
   objectID: string;
 
   /**
-   * The position to promote the objects to (zero-based). If you pass objectIDs, the objects are placed at this position as a group. For example, if you pass four objectIDs to position 0, the objects take the first four positions.
+   * The position to promote the records to. If you pass objectIDs, the records are placed at this position as a group. For example, if you pronmote four objectIDs to position 0, the records take the first four positions.
    */
   position: number;
 };

package/model/promoteObjectIDs.ts

@@ -1,16 +1,16 @@
-// 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.
 
 /**
- * Multiple objectIDs to promote as hits.
+ * Records to promote.
  */
 export type PromoteObjectIDs = {
   /**
-   * Array of unique identifiers of the objects to promote.
+   * Unique identifiers of the records to promote.
    */
   objectIDs: string[];
 
   /**
-   * The position to promote the objects to (zero-based). If you pass objectIDs, the objects are placed at this position as a group. For example, if you pass four objectIDs to position 0, the objects take the first four positions.
+   * The position to promote the records to. If you pass objectIDs, the records are placed at this position as a group. For example, if you pronmote four objectIDs to position 0, the records take the first four positions.
    */
   position: number;
 };

package/model/queryType.ts

@@ -1,6 +1,6 @@
-// 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.
 
 /**
- * Controls if and how query words are interpreted as prefixes.
+ * Determines how query words are [interpreted as prefixes](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/prefix-searching/).
  */
 export type QueryType = 'prefixAll' | 'prefixLast' | 'prefixNone';

package/model/rankingInfo.ts

@@ -1,4 +1,4 @@
-// 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 { MatchedGeoLocation } from './matchedGeoLocation';
 import type { Personalization } from './personalization';

package/model/reRankingApplyFilter.ts

@@ -1,8 +1,8 @@
-// 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 { MixedSearchFilters } from './mixedSearchFilters';
 
 /**
- * When Dynamic Re-Ranking is enabled, only records that match these filters will be impacted by Dynamic Re-Ranking.
+ * When [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/) is enabled, only records that match these filters will be affected by Dynamic Re-Ranking.
  */
 export type ReRankingApplyFilter = MixedSearchFilters[] | string;

package/model/redirect.ts

@@ -0,0 +1,10 @@
+// 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 { RedirectRuleIndexMetadata } from './redirectRuleIndexMetadata';
+
+/**
+ * [Redirect results to a URL](https://www.algolia.com/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/redirects/).
+ */
+export type Redirect = {
+  index?: RedirectRuleIndexMetadata[];
+};

package/model/redirectRuleIndexMetadata.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 { RedirectRuleIndexMetadataData } from './redirectRuleIndexMetadataData';
+
+export type RedirectRuleIndexMetadata = {
+  /**
+   * Source index for the redirect rule.
+   */
+  source: string;
+
+  /**
+   * Destination index for the redirect rule.
+   */
+  dest: string;
+
+  /**
+   * Reason for the redirect rule.
+   */
+  reason: string;
+
+  /**
+   * Redirect rule status.
+   */
+  succeed: boolean;
+
+  data: RedirectRuleIndexMetadataData;
+};

package/model/redirectRuleIndexMetadataData.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.
+
+/**
+ * Redirect rule data.
+ */
+export type RedirectRuleIndexMetadataData = {
+  ruleObjectID: string;
+};

package/model/removeStopWords.ts

@@ -1,6 +1,6 @@
-// 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.
 
 /**
- * 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.
+ * 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 stop words should be enabled. This list will override any values that you may have set in `queryLanguages`. _true_: enables the stop words feature, ensuring that stop words are removed from consideration in a search. The languages supported here are either [every language](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/) (this is the default) or those set by `queryLanguages`. _false_: turns off the stop words feature, allowing stop words to be taken into account in a search.
  */
 export type RemoveStopWords = string[] | boolean;

package/model/removeUserIdResponse.ts

@@ -1,8 +1,8 @@
-// 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.
 
 export type RemoveUserIdResponse = {
   /**
-   * Date of deletion (ISO-8601 format).
+   * Timestamp of deletion in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
    */
   deletedAt: string;
 };

package/model/removeWordsIfNoResults.ts

@@ -1,7 +1,7 @@
-// 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.
 
 /**
- * Selects a strategy to remove words from the query when it doesn\'t match any hits.
+ * Strategy to [remove words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/in-depth/why-use-remove-words-if-no-results/) from the query when it doesn\'t match any hits.
  */
 export type RemoveWordsIfNoResults =
   | 'allOptional'

package/model/renderingContent.ts

@@ -1,9 +1,9 @@
-// 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 { FacetOrdering } from './facetOrdering';
 
 /**
- * Content defining how the search interface should be rendered. Can be set via the settings for a default value and can be overridden via rules.
+ * Extra content for the search UI, for example, to control the [ordering and display of facets](https://www.algolia.com/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/merchandising-facets/#merchandise-facets-and-their-values-in-the-manual-editor). You can set a default value and dynamically override it with [Rules](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/).
  */
 export type RenderingContent = {
   facetOrdering?: FacetOrdering;

package/model/replaceSourceResponse.ts

@@ -1,8 +1,8 @@
-// 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.
 
 export type ReplaceSourceResponse = {
   /**
-   * Date of last update (ISO-8601 format).
+   * Timestamp of the last update in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
    */
   updatedAt: string;
 };

package/model/rule.ts

@@ -1,4 +1,4 @@
-// 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 { Condition } from './condition';
 import type { Consequence } from './consequence';
@@ -9,29 +9,29 @@ import type { TimeRange } from './timeRange';
  */
 export type Rule = {
   /**
-   * Unique identifier of the object.
+   * Unique identifier for a rule object.
    */
   objectID: string;
 
   /**
-   * A list of conditions that should apply to activate a Rule. You can use up to 25 conditions per Rule.
+   * [Conditions](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/#conditions) required to activate a rule. You can use up to 25 conditions per rule.
    */
   conditions?: Condition[];
 
   consequence?: Consequence;
 
   /**
-   * This field is intended for Rule management purposes, in particular to ease searching for Rules and presenting them to human readers. It\'s not interpreted by the API.
+   * Description of the rule\'s purpose. This can be helpful for display in the Algolia dashboard.
    */
   description?: string;
 
   /**
-   * Whether the Rule is enabled. Disabled Rules remain in the index, but aren\'t applied at query time.
+   * Indicates whether to enable the rule. If it isn\'t enabled, it isn\'t applied at query time.
    */
   enabled?: boolean;
 
   /**
-   * By default, Rules are permanently valid. When validity periods are specified, the Rule applies only during those periods; it\'s ignored the rest of the time. The list must not be empty.
+   * If you specify a validity period, the rule _only_ applies only during that period. If specified, the array must not be empty.
    */
   validity?: TimeRange[];
 };

package/model/saveObjectResponse.ts

@@ -1,15 +1,18 @@
-// 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.
 
 export type SaveObjectResponse = {
+  /**
+   * Date of creation (ISO-8601 format).
+   */
   createdAt: string;
 
   /**
-   * TaskID of the task to wait for.
+   * Unique identifier of a task. A successful API response means that a task was added to a queue. It might not run immediately. You can check the task\'s progress with the `task` operation and this `taskID`.
    */
   taskID: number;
 
   /**
-   * Unique identifier of the object.
+   * Unique object identifier.
    */
   objectID?: string;
 };

package/model/saveSynonymResponse.ts

@@ -1,18 +1,18 @@
-// 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.
 
 export type SaveSynonymResponse = {
   /**
-   * TaskID of the task to wait for.
+   * Unique identifier of a task. A successful API response means that a task was added to a queue. It might not run immediately. You can check the task\'s progress with the `task` operation and this `taskID`.
    */
   taskID: number;
 
   /**
-   * Date of last update (ISO-8601 format).
+   * Timestamp of the last update in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
    */
   updatedAt: string;
 
   /**
-   * ObjectID of the inserted object.
+   * Unique identifier of a synonym object.
    */
   id: string;
 };

package/model/scopeType.ts

@@ -1,3 +1,3 @@
-// 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.
 
 export type ScopeType = 'rules' | 'settings' | 'synonyms';

package/model/searchDictionaryEntriesParams.ts

@@ -1,26 +1,26 @@
-// 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.
 
 /**
- * The `searchDictionaryEntries` parameters.
+ * `searchDictionaryEntries` parameters.
  */
 export type SearchDictionaryEntriesParams = {
   /**
-   * The text to search in the index.
+   * Text to search for in an index.
    */
   query: string;
 
   /**
-   * Specify the page to retrieve.
+   * Page to retrieve (the first page is `0`, not `1`).
    */
   page?: number;
 
   /**
-   * Set the number of hits per page.
+   * Number of hits per page.
    */
   hitsPerPage?: number;
 
   /**
-   * Language ISO code supported by the dictionary (e.g., \"en\" for English).
+   * [Supported language ISO code](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/).
    */
   language?: string;
 };

package/model/searchForFacetValuesRequest.ts

@@ -1,8 +1,8 @@
-// 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.
 
 export type SearchForFacetValuesRequest = {
   /**
-   * Search parameters as URL-encoded query string.
+   * Search parameters as a URL-encoded query string.
    */
   params?: string;
 
@@ -12,7 +12,7 @@ export type SearchForFacetValuesRequest = {
   facetQuery?: string;
 
   /**
-   * Maximum number of facet hits to return during a search for facet values. For performance reasons, the maximum allowed number of returned values is 100.
+   * Maximum number of facet hits to return when [searching for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
    */
   maxFacetHits?: number;
 };

package/model/searchForFacetValuesResponse.ts

@@ -1,4 +1,4 @@
-// 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 { FacetHits } from './facetHits';
 

package/model/searchForFacets.ts

@@ -1,4 +1,4 @@
-// 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 { SearchForFacetsOptions } from './searchForFacetsOptions';
 import type { SearchParams } from './searchParams';

package/model/searchForFacetsOptions.ts

@@ -1,15 +1,15 @@
-// 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 { SearchTypeFacet } from './searchTypeFacet';
 
 export type SearchForFacetsOptions = {
   /**
-   * The `facet` name.
+   * Facet name.
    */
   facet: string;
 
   /**
-   * The Algolia index name.
+   * Algolia index name.
    */
   indexName: string;
 
@@ -19,7 +19,7 @@ export type SearchForFacetsOptions = {
   facetQuery?: string;
 
   /**
-   * Maximum number of facet hits to return during a search for facet values. For performance reasons, the maximum allowed number of returned values is 100.
+   * Maximum number of facet hits to return when [searching for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
    */
   maxFacetHits?: number;
 

package/model/searchForHits.ts

@@ -1,4 +1,4 @@
-// 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 { SearchForHitsOptions } from './searchForHitsOptions';
 import type { SearchParams } from './searchParams';

package/model/searchForHitsOptions.ts

@@ -1,10 +1,10 @@
-// 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 { SearchTypeDefault } from './searchTypeDefault';
 
 export type SearchForHitsOptions = {
   /**
-   * The Algolia index name.
+   * Algolia index name.
    */
   indexName: string;
 

package/model/searchHits.ts

@@ -1,7 +1,17 @@
-// 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 { Hit } from './hit';
 
-export type SearchHits<T = Record<string, any>> = {
+export type SearchHits<T = Record<string, any>> = Record<string, any> & {
   hits: Array<Hit<T>>;
+
+  /**
+   * Text to search for in an index.
+   */
+  query: T;
+
+  /**
+   * URL-encoded string of all search parameters.
+   */
+  params: T;
 };

package/model/searchMethodParams.ts

@@ -1,4 +1,4 @@
-// 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 { SearchQuery } from './searchQuery';
 import type { SearchStrategy } from './searchStrategy';

package/model/searchParams.ts

@@ -1,4 +1,4 @@
-// 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 { SearchParamsObject } from './searchParamsObject';
 import type { SearchParamsString } from './searchParamsString';

package/model/searchParamsObject.ts

@@ -1,4 +1,4 @@
-// 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 { BaseSearchParams } from './baseSearchParams';
 import type { IndexSettingsAsSearchParams } from './indexSettingsAsSearchParams';

package/model/searchParamsQuery.ts

@@ -1,8 +1,8 @@
-// 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.
 
 export type SearchParamsQuery = {
   /**
-   * The text to search in the index.
+   * Text to search for in an index.
    */
   query?: string;
 };

package/model/searchParamsString.ts

@@ -1,8 +1,8 @@
-// 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.
 
 export type SearchParamsString = {
   /**
-   * Search parameters as URL-encoded query string.
+   * Search parameters as a URL-encoded query string.
    */
   params?: string;
 };

package/model/searchQuery.ts

@@ -1,4 +1,4 @@
-// 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 { SearchForFacets } from './searchForFacets';
 import type { SearchForHits } from './searchForHits';

package/model/searchResponse.ts

@@ -1,4 +1,4 @@
-// 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 { BaseSearchResponse } from './baseSearchResponse';
 import type { SearchHits } from './searchHits';

package/model/searchResponses.ts

@@ -1,7 +1,7 @@
-// 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 { SearchResponse } from './searchResponse';
+import type { SearchResult } from './searchResult';
 
-export type SearchResponses<T = Record<string, any>> = {
-  results: Array<SearchResponse<T>>;
+export type SearchResponses = {
+  results: SearchResult[];
 };

package/model/searchResult.ts

@@ -0,0 +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 { SearchForFacetValuesResponse } from './searchForFacetValuesResponse';
+import type { SearchResponse } from './searchResponse';
+
+export type SearchResult = SearchForFacetValuesResponse | SearchResponse;

package/model/searchRulesParams.ts

@@ -1,40 +1,40 @@
-// 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 { Anchoring } from './anchoring';
 
 /**
- * Parameters for the search.
+ * Rules search parameters.
  */
 export type SearchRulesParams = {
   /**
-   * Full text query.
+   * Rule object query.
    */
   query?: string;
 
   anchoring?: Anchoring;
 
   /**
-   * Restricts matches to contextual rules with a specific context (exact match).
+   * Restricts responses to the specified [contextual rule](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/how-to/customize-search-results-by-platform/#creating-contextual-rules).
    */
   context?: string;
 
   /**
-   * Requested page (zero-based).
+   * Requested page (the first page is page 0).
    */
   page?: number;
 
   /**
-   * Maximum number of hits in a page. Minimum is 1, maximum is 1000.
+   * Maximum number of hits per page.
    */
   hitsPerPage?: number;
 
   /**
-   * When specified, restricts matches to rules with a specific enabled status. When absent (default), all rules are retrieved, regardless of their enabled status.
+   * Restricts responses to enabled rules. When not specified (default), _all_ rules are retrieved.
    */
-  enabled?: boolean;
+  enabled?: boolean | null;
 
   /**
-   * A mapping of requestOptions to send along with the request.
+   * Request options to send with the API call.
    */
   requestOptions?: Array<Record<string, any>>;
 };

package/model/searchRulesResponse.ts

@@ -1,4 +1,4 @@
-// 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 { Rule } from './rule';
 

package/model/searchStrategy.ts

@@ -1,3 +1,6 @@
-// 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.
 
+/**
+ * - `none`: executes all queries. - `stopIfEnoughMatches`: executes queries one by one, stopping further query execution as soon as a query matches at least the `hitsPerPage` number of results.
+ */
 export type SearchStrategy = 'none' | 'stopIfEnoughMatches';

package/model/searchSynonymsParams.ts

@@ -1,8 +1,8 @@
-// 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.
 
 export type SearchSynonymsParams = {
   /**
-   * The text to search in the index.
+   * Text to search for in an index.
    */
   query?: string;
 };

package/model/searchSynonymsResponse.ts

@@ -1,15 +1,15 @@
-// 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 { SynonymHit } from './synonymHit';
 
 export type SearchSynonymsResponse = Record<string, any> & {
   /**
-   * Array of synonym objects.
+   * Synonym objects.
    */
   hits: SynonymHit[];
 
   /**
-   * Number of hits that the search query matched.
+   * Number of hits the search query matched.
    */
   nbHits: number;
 };