@algolia/client-search 5.0.0-alpha.99 → 5.0.0-beta.10

package/model/consequenceHide.ts

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

package/model/consequenceQuery.ts

@@ -3,6 +3,6 @@
 import type { ConsequenceQueryObject } from './consequenceQueryObject';
 
 /**
- * When providing a string, it replaces the entire query string. When providing an object, it describes incremental edits to be made to the query string (but you can\'t do both).
+ * 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;

package/model/consequenceQueryObject.ts

@@ -4,12 +4,12 @@ import type { Edit } from './edit';
 
 export type ConsequenceQueryObject = {
   /**
-   * Words to remove.
+   * Words to remove from the search query.
    */
   remove?: string[];
 
   /**
-   * Edits to apply.
+   * Changes to make to the search query.
    */
   edits?: Edit[];
 };

package/model/createdAtResponse.ts

@@ -5,7 +5,7 @@
  */
 export type CreatedAtResponse = {
   /**
-   * Timestamp of creation in [ISO-8601](https://wikipedia.org/wiki/ISO_8601) format.
+   * Date and time when the object was created, in RFC 3339 format.
    */
   createdAt: string;
 };

package/model/cursor.ts

@@ -2,7 +2,7 @@
 
 export type Cursor = {
   /**
-   * Cursor indicating the location to resume browsing from. Must match the value returned by the previous call. Pass this value to the subsequent browse call to get the next page of results. When the end of the index has been reached, `cursor` is absent from the response.
+   * Cursor to get the next page of the response.  The parameter must match the value returned in the response of a previous request. The last page of the response does not return a `cursor` attribute.
    */
   cursor?: string;
 };

package/model/deleteApiKeyResponse.ts

@@ -2,7 +2,7 @@
 
 export type DeleteApiKeyResponse = {
   /**
-   * Timestamp of deletion in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
+   * Date and time when the object was deleted, in RFC 3339 format.
    */
   deletedAt: string;
 };

package/model/deleteByParams.ts

@@ -9,7 +9,7 @@ export type DeleteByParams = {
   facetFilters?: FacetFilters;
 
   /**
-   * [Filter](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/) the query with numeric, facet, or tag filters.
+   * Filter expression to only include items that match the filter criteria in the response.  You can use these filter expressions:  - **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;
 
@@ -18,19 +18,19 @@ export type DeleteByParams = {
   tagFilters?: TagFilters;
 
   /**
-   * Search for entries [around a central location](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filter-around-a-central-point), enabling a geographical 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;
 
   aroundRadius?: AroundRadius;
 
   /**
-   * Search inside a [rectangular area](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas) (in geographical 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[][];
 
   /**
-   * Search inside a [polygon](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas) (in geographical 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[][];
 };

package/model/deleteSourceResponse.ts

@@ -2,7 +2,7 @@
 
 export type DeleteSourceResponse = {
   /**
-   * Timestamp of deletion in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
+   * Date and time when the object was deleted, in RFC 3339 format.
    */
   deletedAt: string;
 };

package/model/deletedAtResponse.ts

@@ -5,12 +5,12 @@
  */
 export type DeletedAtResponse = {
   /**
-   * 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`.
+   * 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](#tag/Indices/operation/getTask) and this `taskID`.
    */
   taskID: number;
 
   /**
-   * Timestamp of deletion in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
+   * Date and time when the object was deleted, in RFC 3339 format.
    */
   deletedAt: string;
 };

package/model/dictionaryEntry.ts

@@ -1,33 +1,31 @@
 // 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 { DictionaryEntryState } from './dictionaryEntryState';
+import type { SupportedLanguage } from './supportedLanguage';
 
 /**
  * Dictionary entry.
  */
 export type DictionaryEntry = Record<string, any> & {
   /**
-   * Unique identifier for a dictionary object.
+   * Unique identifier for the dictionary entry.
    */
   objectID: string;
 
-  /**
-   * [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;
+  language: SupportedLanguage;
 
   /**
-   * Dictionary entry word. Usage depends on the type of dictionary entry. **`stopwordEntry`** The stop word you want to add or update. If the entry already exists in Algolia\'s standard dictionary, you can override its behavior by adding it to the custom dictionary and setting its `state` to `disabled`. **`compoundEntry`** When `decomposition` is empty: adds `word` as a compound atom. For example, atom “kino” decomposes the query “kopfkino” into \"kopf\" and \"kino\". When `decomposition` isn\'t empty: creates a decomposition exception. For example, when decomposition is set to the [\"hund\", \"hutte\"] exception, \"hundehutte\" decomposes into “hund” and “hutte”, discarding the linking \"e\".
+   * Matching dictionary word for `stopwords` and `compounds` dictionaries.
    */
   word?: string;
 
   /**
-   * Compound dictionary [word declensions](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-plurals-and-other-declensions/). If the entry already exists in Algolia\'s standard dictionary, you can override its behavior by adding it to the custom dictionary and setting its `state` to `disabled`.
+   * Matching words in the `plurals` dictionary including declensions.
    */
   words?: string[];
 
   /**
-   * For compound entries, governs the behavior of the `word` parameter.
+   * Invividual components of a compound word in the `compounds` dictionary.
    */
   decomposition?: string[];
 

package/model/dictionaryEntryState.ts

@@ -1,6 +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.
 
 /**
- * Indicates whether a dictionary entry is active (`enabled`) or inactive (`disabled`).
+ * Whether a dictionary entry is active.
  */
 export type DictionaryEntryState = 'disabled' | 'enabled';

package/model/dictionaryLanguage.ts

@@ -1,11 +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.
 
 /**
- * Custom entries for a dictionary.
+ * Dictionary type. If `null`, this dictionary type isn\'t supported for the language.
  */
 export type DictionaryLanguage = {
   /**
-   * If `0`, the dictionary hasn\'t been customized and only contains standard entries provided by Algolia. If `null`, that feature isn\'t available or isn\'t supported for that language.
+   * Number of custom dictionary entries.
    */
   nbCustomEntries?: number;
 };

package/model/dictionarySettingsParams.ts

@@ -3,7 +3,7 @@
 import type { StandardEntries } from './standardEntries';
 
 /**
- * Enable or turn off the built-in Algolia stop words for a specific language.
+ * Turn on or off the built-in Algolia stop words for a specific language.
  */
 export type DictionarySettingsParams = {
   disableStandardEntries: StandardEntries;

package/model/distinct.ts

@@ -1,6 +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.
 
 /**
- * Enables [deduplication or grouping of results (Algolia\'s _distinct_ feature](https://www.algolia.com/doc/guides/managing-results/refine-results/grouping/#introducing-algolias-distinct-feature)).
+ * Determines how many records of a group are included in the search results.  Records with the same value for the `attributeForDistinct` attribute are considered a group. The `distinct` setting controls how many members of the group are returned. This is useful for [deduplication and grouping](https://www.algolia.com/doc/guides/managing-results/refine-results/grouping/#introducing-algolias-distinct-feature).  The `distinct` setting is ignored if `attributeForDistinct` is not set.
  */
 export type Distinct = boolean | number;

package/model/edit.ts

@@ -11,7 +11,7 @@ export type Edit = {
   delete?: string;
 
   /**
-   * Text that should be inserted in place of the removed text inside the query string.
+   * Text to be added in place of the deleted text inside the query string.
    */
   insert?: string;
 };

package/model/exactOnSingleWordQuery.ts

@@ -1,6 +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.
 
 /**
- * Determines how the [Exact ranking criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes) is computed when the query contains only one word.
+ * Determines how the [Exact ranking criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes) is computed when the search query has only one word.  - `attribute`.   The Exact ranking criterion is 1 if the query word and attribute value are the same.   For example, a search for \"road\" will match the value \"road\", but not \"road trip\".  - `none`.   The Exact ranking criterion is ignored on single-word searches.  - `word`.   The Exact ranking criterion is 1 if the query word is found in the attribute value.   The query word must have at least 3 characters and must not be a stop word.   Only exact matches will be highlighted,   partial and prefix matches won\'t.
  */
 export type ExactOnSingleWordQuery = 'attribute' | 'none' | 'word';

package/model/facetFilters.ts

@@ -1,8 +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 { MixedSearchFilters } from './mixedSearchFilters';
-
 /**
- * [Filter hits by facet value](https://www.algolia.com/doc/api-reference/api-parameters/facetFilters/).
+ * Filter the search by facet values, so that only records with the same facet values are retrieved.  **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.**  - `[filter1, filter2]` is interpreted as `filter1 AND filter2`. - `[[filter1, filter2], filter3]` is interpreted as `filter1 OR filter2 AND filter3`. - `facet:-value` is interpreted as `NOT facet:value`.  While it\'s best to avoid attributes that start with a `-`, you can still filter them by escaping with a backslash: `facet:\\-value`.
  */
-export type FacetFilters = MixedSearchFilters[] | string;
+export type FacetFilters = FacetFilters[] | string;

package/model/facetHits.ts

@@ -7,12 +7,12 @@ export type FacetHits = {
   value: string;
 
   /**
-   * Markup text with `facetQuery` matches highlighted.
+   * Highlighted attribute value, including HTML tags.
    */
   highlighted: string;
 
   /**
-   * Number of records containing this facet value. This takes into account the extra search parameters specified in the query. Like for a regular search query, the [counts may not be exhaustive](https://support.algolia.com/hc/en-us/articles/4406975248145-Why-are-my-facet-and-hit-counts-not-accurate-).
+   * Number of records with this facet value. [The count may be approximated](https://support.algolia.com/hc/en-us/articles/4406975248145-Why-are-my-facet-and-hit-counts-not-accurate-).
    */
   count: number;
 };

package/model/facetOrdering.ts

@@ -4,13 +4,13 @@ import type { Facets } from './facets';
 import type { Value } from './value';
 
 /**
- * Defines the ordering of facets (widgets).
+ * Order of facet names and facet values in your UI.
  */
 export type FacetOrdering = {
   facets?: Facets;
 
   /**
-   * Ordering of facet values within an individual facet.
+   * Order of facet values. One object for each facet.
    */
   values?: Record<string, Value>;
 };

package/model/facets.ts

@@ -1,11 +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.
 
 /**
- * Ordering of facets (widgets).
+ * Order of facet names.
  */
 export type Facets = {
   /**
-   * Pinned order of facet lists.
+   * Explicit order of facets or facet values.  This setting lets you always show specific facets or facet values at the top of the list.
    */
   order?: string[];
 };

package/model/fetchedIndex.ts

@@ -12,7 +12,7 @@ export type FetchedIndex = {
   createdAt: string;
 
   /**
-   * Timestamp of the last update in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
+   * Date and time when the object was updated, in RFC 3339 format.
    */
   updatedAt: string;
 
@@ -55,4 +55,9 @@ export type FetchedIndex = {
    * Only present if the index is a primary index with replicas. Contains the names of all linked replicas.
    */
   replicas?: string[];
+
+  /**
+   * Only present if the index is a [virtual replica](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/sort-an-index-alphabetically/#virtual-replicas).
+   */
+  virtual?: boolean;
 };

package/model/getObjectsRequest.ts

@@ -1,7 +1,7 @@
 // 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.
 
 /**
- * Record retrieval operation.
+ * Request body for retrieving records.
  */
 export type GetObjectsRequest = {
   /**
@@ -10,12 +10,12 @@ export type GetObjectsRequest = {
   attributesToRetrieve?: string[];
 
   /**
-   * Record\'s objectID.
+   * Object ID for the record to retrieve.
    */
   objectID: string;
 
   /**
-   * Name of the index containing the required records.
+   * Index from which to retrieve the records.
    */
   indexName: string;
 };

package/model/getObjectsResponse.ts

@@ -2,7 +2,7 @@
 
 export type GetObjectsResponse<T = Record<string, any>> = {
   /**
-   * Retrieved results.
+   * Retrieved records.
    */
   results: T[];
 };

package/model/hasPendingMappingsResponse.ts

@@ -2,7 +2,7 @@
 
 export type HasPendingMappingsResponse = {
   /**
-   * Indicates whether there are clusters undergoing migration, creation, or deletion.
+   * Whether there are clusters undergoing migration, creation, or deletion.
    */
   pending: boolean;
 

package/model/highlightResult.ts

@@ -4,4 +4,5 @@ import type { HighlightResultOption } from './highlightResultOption';
 
 export type HighlightResult =
   | HighlightResultOption
+  | HighlightResultOption[]
   | Record<string, HighlightResultOption>;

package/model/highlightResultOption.ts

@@ -3,18 +3,18 @@
 import type { MatchLevel } from './matchLevel';
 
 /**
- * Show highlighted section and words matched on a query.
+ * Surround words that match the query with HTML tags for highlighting.
  */
 export type HighlightResultOption = {
   /**
-   * Markup text with `facetQuery` matches highlighted.
+   * Highlighted attribute value, including HTML tags.
    */
   value: string;
 
   matchLevel: MatchLevel;
 
   /**
-   * List of words from the query that matched the object.
+   * List of matched words from the search query.
    */
   matchedWords: string[];
 

package/model/hit.ts

@@ -5,21 +5,21 @@ import type { RankingInfo } from './rankingInfo';
 import type { SnippetResult } from './snippetResult';
 
 /**
- * A single hit.
+ * Search result.  A hit is a record from your index, augmented with special attributes for highlighting, snippeting, and ranking.
  */
 export type Hit<T = Record<string, any>> = T & {
   /**
-   * Unique object identifier.
+   * Unique record identifier.
    */
   objectID: string;
 
   /**
-   * Show highlighted section and words matched on a query.
+   * Surround words that match the query with HTML tags for highlighting.
    */
   _highlightResult?: Record<string, HighlightResult>;
 
   /**
-   * Snippeted attributes show parts of the matched attributes. Only returned when attributesToSnippet is non-empty.
+   * Snippets that show the context around a matching search query.
    */
   _snippetResult?: Record<string, SnippetResult>;
 

package/model/ignorePlurals.ts

@@ -1,6 +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 { SupportedLanguage } from './supportedLanguage';
+
 /**
- * Treats singular, plurals, and other forms of declensions as matching terms. `ignorePlurals` is used in conjunction with the `queryLanguages` setting. _list_: language ISO codes for which ignoring plurals should be enabled. This list will override any values that you may have set in `queryLanguages`. _true_: enables the ignore plurals feature, where singulars and plurals are considered equivalent (\"foot\" = \"feet\"). 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 ignore plurals feature, so that singulars and plurals aren\'t considered to be the same (\"foot\" will not find \"feet\").
+ * Treat singular, plurals, and other forms of declensions as equivalent. You should only use this feature for the languages used in your index.
  */
-export type IgnorePlurals = string[] | boolean;
+export type IgnorePlurals = SupportedLanguage[] | boolean;

package/model/index.ts

@@ -7,6 +7,7 @@ export * from './advancedSyntaxFeatures';
 export * from './alternativesAsExact';
 export * from './anchoring';
 export * from './apiKey';
+export * from './apiKeyOperation';
 export * from './aroundPrecision';
 export * from './aroundPrecisionFromValueInner';
 export * from './aroundRadius';
@@ -27,6 +28,7 @@ export * from './batchParams';
 export * from './batchRequest';
 export * from './batchResponse';
 export * from './batchWriteParams';
+export * from './browsePagination';
 export * from './browseParams';
 export * from './browseParamsObject';
 export * from './browseResponse';
@@ -87,7 +89,6 @@ export * from './logQuery';
 export * from './logType';
 export * from './matchLevel';
 export * from './matchedGeoLocation';
-export * from './mixedSearchFilters';
 export * from './mode';
 export * from './multipleBatchRequest';
 export * from './multipleBatchResponse';
@@ -106,16 +107,19 @@ export * from './reRankingApplyFilter';
 export * from './redirect';
 export * from './redirectRuleIndexMetadata';
 export * from './redirectRuleIndexMetadataData';
+export * from './redirectURL';
 export * from './removeStopWords';
 export * from './removeUserIdResponse';
 export * from './removeWordsIfNoResults';
 export * from './renderingContent';
+export * from './replaceAllObjectsResponse';
 export * from './replaceSourceResponse';
 export * from './rule';
 export * from './saveObjectResponse';
 export * from './saveSynonymResponse';
 export * from './scopeType';
 export * from './searchDictionaryEntriesParams';
+export * from './searchDictionaryEntriesResponse';
 export * from './searchForFacetValuesRequest';
 export * from './searchForFacetValuesResponse';
 export * from './searchForFacets';
@@ -124,6 +128,7 @@ export * from './searchForHits';
 export * from './searchForHitsOptions';
 export * from './searchHits';
 export * from './searchMethodParams';
+export * from './searchPagination';
 export * from './searchParams';
 export * from './searchParamsObject';
 export * from './searchParamsQuery';
@@ -141,12 +146,14 @@ export * from './searchTypeDefault';
 export * from './searchTypeFacet';
 export * from './searchUserIdsParams';
 export * from './searchUserIdsResponse';
+export * from './securedApiKeyRestrictions';
 export * from './semanticSearch';
 export * from './snippetResult';
 export * from './snippetResultOption';
 export * from './sortRemainingBy';
 export * from './source';
 export * from './standardEntries';
+export * from './supportedLanguage';
 export * from './synonymHit';
 export * from './synonymType';
 export * from './tagFilters';

package/model/indexSettings.ts

@@ -4,6 +4,6 @@ import type { BaseIndexSettings } from './baseIndexSettings';
 import type { IndexSettingsAsSearchParams } from './indexSettingsAsSearchParams';
 
 /**
- * Algolia index settings.
+ * Index settings.
  */
 export type IndexSettings = BaseIndexSettings & IndexSettingsAsSearchParams;