@algolia/client-search 5.0.0-alpha.10 → 5.0.0-alpha.101

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,22 @@
-// 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 { SynonymType } from './synonymType';
 
 export type SearchSynonymsParams = {
   /**
-   * The text to search in the index.
+   * Text to search for in an index.
    */
   query?: string;
+
+  type?: SynonymType;
+
+  /**
+   * Page to retrieve (the first page is `0`, not `1`).
+   */
+  page?: number;
+
+  /**
+   * Number of hits per page.
+   */
+  hitsPerPage?: number;
 };

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;
 };

package/model/searchTypeDefault.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.
 
 /**
- * Perform a search query with `default`, will search for facet values if `facet` is given.
+ * - `default`: perform a search query - `facet` [searches for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
  */
 export type SearchTypeDefault = 'default';

package/model/searchTypeFacet.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.
 
 /**
- * Perform a search query with `default`, will search for facet values if `facet` is given.
+ * - `default`: perform a search query - `facet` [searches for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
  */
 export type SearchTypeFacet = 'facet';

package/model/searchUserIdsParams.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.
 
 /**
  * OK.
  */
 export type SearchUserIdsParams = {
   /**
-   * Query to search. The search is a prefix search with typoTolerance. Use empty query to retrieve all users.
+   * Query to search. The search is a prefix search with [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/) enabled. An empty query will retrieve all users.
    */
   query: string;
 
   /**
-   * Name of the cluster.
+   * Cluster name.
    */
   clusterName?: 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;
 };

package/model/searchUserIdsResponse.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 { UserHit } from './userHit';
 
@@ -7,27 +7,27 @@ import type { UserHit } from './userHit';
  */
 export type SearchUserIdsResponse = {
   /**
-   * List of user object matching the query.
+   * User objects that match the query.
    */
   hits: UserHit[];
 
   /**
-   * Number of hits that the search query matched.
+   * Number of hits the search query matched.
    */
   nbHits: number;
 
   /**
-   * Specify the page to retrieve.
+   * Page to retrieve (the first page is `0`, not `1`).
    */
   page: number;
 
   /**
-   * Maximum number of hits in a page. Minimum is 1, maximum is 1000.
+   * Maximum number of hits per page.
    */
   hitsPerPage: 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;
 };

package/model/semanticSearch.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.
+
+/**
+ * Settings for the semantic search part of NeuralSearch. Only used when `mode` is _neuralSearch_.
+ */
+export type SemanticSearch = {
+  /**
+   * Indices from which to collect click and conversion events. If null, the current index and replica group will be used as the event source.
+   */
+  eventSources?: string[] | null;
+};

package/model/snippetResult.ts

@@ -1,5 +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 { SnippetResultOption } from './snippetResultOption';
 
-export type SnippetResult = SnippetResultOption | SnippetResultOption[];
+export type SnippetResult =
+  | Record<string, SnippetResultOption>
+  | SnippetResultOption
+  | SnippetResultOption[];

package/model/snippetResultOption.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 { MatchLevel } from './matchLevel';
 
@@ -7,7 +7,7 @@ import type { MatchLevel } from './matchLevel';
  */
 export type SnippetResultOption = {
   /**
-   * Markup text with occurrences highlighted.
+   * Markup text with `facetQuery` matches highlighted.
    */
   value: string;
 

package/model/sortRemainingBy.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.
 
 /**
- * How to display the remaining items.   - `count`: facet count (descending).   - `alpha`: alphabetical (ascending).   - `hidden`: show only pinned values.
+ * How to display the remaining items:    - `count`: facet count (descending).   - `alpha`: alphabetical (ascending).   - `hidden`: show only pinned values.
  */
 export type SortRemainingBy = 'alpha' | 'count' | 'hidden';

package/model/source.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.
 
 /**
- * The source.
+ * Source.
  */
 export type Source = {
   /**
-   * The IP range of the source.
+   * IP address range of the source.
    */
   source: string;
 
   /**
-   * The description of the source.
+   * Source description.
    */
   description?: string;
 };

package/model/standardEntries.ts

@@ -1,21 +1,21 @@
-// 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.
 
 /**
- * Map of language ISO code supported by the dictionary (e.g., \"en\" for English) to a boolean value.
+ * Key-value pairs of [supported language ISO codes](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/) and boolean values.
  */
 export type StandardEntries = {
   /**
-   * Language ISO code.
+   * Key-value pair of a language ISO code and a boolean value.
    */
   plurals?: Record<string, boolean> | null;
 
   /**
-   * Language ISO code.
+   * Key-value pair of a language ISO code and a boolean value.
    */
   stopwords?: Record<string, boolean> | null;
 
   /**
-   * Language ISO code.
+   * Key-value pair of a language ISO code and a boolean value.
    */
   compounds?: Record<string, boolean> | null;
 };

package/model/synonymHit.ts

@@ -1,6 +1,5 @@
-// 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 { SynonymHitHighlightResult } from './synonymHitHighlightResult';
 import type { SynonymType } from './synonymType';
 
 /**
@@ -8,24 +7,24 @@ import type { SynonymType } from './synonymType';
  */
 export type SynonymHit = {
   /**
-   * Unique identifier of the synonym object to be created or updated.
+   * Unique identifier of a synonym object.
    */
   objectID: string;
 
   type: SynonymType;
 
   /**
-   * Words or phrases to be considered equivalent.
+   * Words or phrases considered equivalent.
    */
   synonyms?: string[];
 
   /**
-   * Word or phrase to appear in query strings (for onewaysynonym).
+   * Word or phrase to appear in query strings (for [`onewaysynonym`s](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/one-way-synonyms/)).
    */
   input?: string;
 
   /**
-   * Word or phrase to appear in query strings (for altcorrection1 and altcorrection2).
+   * Word or phrase to appear in query strings (for [`altcorrection1` and `altcorrection2`](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/synonyms-alternative-corrections/)).
    */
   word?: string;
 
@@ -35,14 +34,12 @@ export type SynonymHit = {
   corrections?: string[];
 
   /**
-   * Token to be put inside records.
+   * [Placeholder token](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/synonyms-placeholders/) to be put inside records.
    */
   placeholder?: string;
 
   /**
-   * List of query words that will match the token.
+   * Query words that will match the [placeholder token](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/synonyms-placeholders/).
    */
   replacements?: string[];
-
-  _highlightResult?: SynonymHitHighlightResult;
 };

package/model/synonymType.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.
 
 /**
- * Type of the synonym object.
+ * Synonym type.
  */
 export type SynonymType =
   | 'altcorrection1'

package/model/tagFilters.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';
 
 /**
- * Filter hits by tags.
+ * [Filter hits by tags](https://www.algolia.com/doc/api-reference/api-parameters/tagFilters/).
  */
 export type TagFilters = MixedSearchFilters[] | string;

package/model/taskStatus.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.
 
+/**
+ * _published_ if the task has been processed, _notPublished_ otherwise.
+ */
 export type TaskStatus = 'notPublished' | 'published';

package/model/timeRange.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.
 
 export type TimeRange = {
   /**

package/model/typoTolerance.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 { TypoToleranceEnum } from './typoToleranceEnum';
 
 /**
- * Controls whether typo tolerance is enabled and how it is applied.
+ * Controls whether [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/) is enabled and how it is applied.
  */
 export type TypoTolerance = TypoToleranceEnum | boolean;

package/model/typoToleranceEnum.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 TypoToleranceEnum = 'min' | 'strict';

package/model/updateApiKeyResponse.ts

@@ -1,13 +1,13 @@
-// 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 UpdateApiKeyResponse = {
   /**
-   * The API key.
+   * API key.
    */
   key: string;
 
   /**
-   * 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/updatedAtResponse.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.
 
 /**
- * The response with a taskID and an updatedAt timestamp.
+ * Response, taskID, and update timestamp.
  */
 export type UpdatedAtResponse = {
   /**
-   * 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;
 };

package/model/updatedAtWithObjectIdResponse.ts

@@ -1,21 +1,21 @@
-// 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 response with a taskID, an objectID and an updatedAt timestamp.
+ * Response, taskID, unique object identifier, and an update timestamp.
  */
 export type UpdatedAtWithObjectIdResponse = {
   /**
-   * 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;
 
   /**
-   * Unique identifier of the object.
+   * Unique object identifier.
    */
   objectID?: string;
 };

package/model/updatedRuleResponse.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 UpdatedRuleResponse = {
   /**
-   * Unique identifier of the object.
+   * Unique object identifier.
    */
   objectID: string;
 
   /**
-   * Date of last update (ISO-8601 format).
+   * Timestamp of the last update in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
    */
   updatedAt: 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;
 };

package/model/userHighlightResult.ts

@@ -1,15 +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 { HighlightResult } from './highlightResult';
 
 export type UserHighlightResult = {
-  /**
-   * Show highlighted section and words matched on a query.
-   */
-  userID: Record<string, HighlightResult>;
+  userID: HighlightResult;
 
-  /**
-   * Show highlighted section and words matched on a query.
-   */
-  clusterName: Record<string, HighlightResult>;
+  clusterName: HighlightResult;
 };

package/model/userHit.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 { UserHighlightResult } from './userHighlightResult';
 
@@ -9,7 +9,7 @@ export type UserHit = {
   userID: string;
 
   /**
-   * Name of the cluster.
+   * Cluster name.
    */
   clusterName: string;
 

package/model/userId.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.
 
 /**
- * A userID.
+ * Unique user ID.
  */
 export type UserId = {
   /**
@@ -10,7 +10,7 @@ export type UserId = {
   userID: string;
 
   /**
-   * Cluster on which the user is assigned.
+   * Cluster to which the user is assigned.
    */
   clusterName: string;
 

package/model/value.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 { SortRemainingBy } from './sortRemainingBy';