@algolia/client-search 5.0.0-alpha.1 → 5.0.0-alpha.100

package/model/log.ts

@@ -1,66 +1,80 @@
-// 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 { LogQuery } from './logQuery';
 
 export type Log = {
   /**
-   * Timestamp in ISO-8601 format.
+   * Timestamp in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
    */
   timestamp: string;
+
   /**
    * HTTP method of the performed request.
    */
   method: string;
+
   /**
    * HTTP response code.
    */
   answer_code: string;
+
   /**
-   * Request body. Truncated after 1000 characters.
+   * Request body. Truncated after 1,000 characters.
    */
   query_body: string;
+
   /**
-   * Answer body. Truncated after 1000 characters.
+   * Answer body. Truncated after 1,000 characters.
    */
   answer: string;
+
   /**
    * Request URL.
    */
   url: string;
+
   /**
-   * IP of the client which performed the request.
+   * IP address of the client that performed the request.
    */
   ip: string;
+
   /**
-   * Request Headers (API Key is obfuscated).
+   * Request headers (API key is obfuscated).
    */
   query_headers: string;
+
   /**
    * SHA1 signature of the log entry.
    */
   sha1: string;
+
   /**
    * Number of API calls.
    */
   nb_api_calls: string;
+
   /**
-   * Processing time for the query. It doesn\'t include network time.
+   * Processing time for the query. Doesn\'t include network time.
    */
   processing_time_ms: string;
+
   /**
    * Index targeted by the query.
    */
   index?: string;
+
   /**
    * Query parameters sent with the request.
    */
   query_params?: string;
+
   /**
    * Number of hits returned for the query.
    */
   query_nb_hits?: string;
+
   /**
-   * Array of all performed queries for the given request.
+   * Performed queries for the given request.
    */
   inner_queries?: LogQuery[];
 };

package/model/logQuery.ts

@@ -1,16 +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 LogQuery = {
   /**
    * Index targeted by the query.
    */
   index_name?: string;
+
   /**
    * User identifier.
    */
   user_token?: string;
+
   /**
-   * QueryID for the given query.
+   * Unique query identifier.
    */
   query_id?: string;
 };

package/model/logType.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 LogType = 'all' | 'build' | 'error' | 'query';

package/model/matchLevel.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.
 
 /**
  * Indicates how well the attribute matched the search query.

package/model/matchedGeoLocation.ts

@@ -1,14 +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.
 
 export type MatchedGeoLocation = {
   /**
    * Latitude of the matched location.
    */
   lat?: number;
+
   /**
    * Longitude of the matched location.
    */
   lng?: number;
+
   /**
    * Distance between the matched location and the search location (in meters).
    */

package/model/mixedSearchFilters.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 MixedSearchFilters = string[] | string;

package/model/mode.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.
+
+/**
+ * Search mode the index will use to query for results.
+ */
+export type Mode = 'keywordSearch' | 'neuralSearch';

package/model/multipleBatchRequest.ts

@@ -0,0 +1,17 @@
+// 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 { Action } from './action';
+
+export type MultipleBatchRequest = {
+  action: Action;
+
+  /**
+   * Operation arguments (varies with specified `action`).
+   */
+  body: Record<string, any>;
+
+  /**
+   * Index to target for this operation.
+   */
+  indexName: string;
+};

package/model/multipleBatchResponse.ts

@@ -1,12 +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 MultipleBatchResponse = {
   /**
-   * List of tasksIDs per index.
+   * TaskIDs per index.
    */
-  taskID?: Record<string, any>;
+  taskID: Record<string, number>;
+
   /**
-   * List of objectID.
+   * Unique object (record) identifiers.
    */
-  objectIDs?: string[];
+  objectIDs: string[];
 };

package/model/numericFilters.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 on numeric attributes.
+ * [Filter on numeric attributes](https://www.algolia.com/doc/api-reference/api-parameters/numericFilters/).
  */
 export type NumericFilters = MixedSearchFilters[] | string;

package/model/operationIndexParams.ts

@@ -1,16 +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.
 
 import type { OperationType } from './operationType';
 import type { ScopeType } from './scopeType';
 
 export type OperationIndexParams = {
   operation: OperationType;
+
   /**
-   * The Algolia index name.
+   * Algolia index name.
    */
   destination: string;
+
   /**
-   * Scope of the data to copy. When absent, a full copy is performed. When present, only the selected scopes are copied.
+   * **This only applies to the _copy_ operation.**  If you omit `scope`, the copy command copies all records, settings, synonyms, and rules.  If you specify `scope`, only the specified scopes are copied.
    */
   scope?: ScopeType[];
 };

package/model/operationType.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.
 
 /**
- * Type of operation to perform (move or copy).
+ * Operation to perform (_move_ or _copy_).
  */
 export type OperationType = 'copy' | 'move';

package/model/optionalFilters.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';
 
 /**
- * Create filters for ranking purposes, where records that match the filter are ranked higher, or lower in the case of a negative optional filter.
+ * Create filters to boost or demote records.   Records that match the filter are ranked higher for positive and lower for negative optional filters. In contrast to regular filters, records that don\'t match the optional filter are still included in the results, only their ranking is affected.
  */
 export type OptionalFilters = MixedSearchFilters[] | string;

package/model/params.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.
 
 import type { AutomaticFacetFilters } from './automaticFacetFilters';
 import type { ConsequenceQuery } from './consequenceQuery';
 import type { RenderingContent } from './renderingContent';
 
 /**
- * Additional search parameters. Any valid search parameter is allowed.
+ * Additional search parameters.
  */
 export type Params = {
   query?: ConsequenceQuery;
+
   automaticFacetFilters?: AutomaticFacetFilters;
+
   automaticOptionalFacetFilters?: AutomaticFacetFilters;
+
   renderingContent?: RenderingContent;
 };

package/model/personalization.ts

@@ -1,14 +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.
 
 export type Personalization = {
   /**
    * The score of the filters.
    */
   filtersScore?: number;
+
   /**
    * The score of the ranking.
    */
   rankingScore?: number;
+
   /**
    * The score of the event.
    */

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,15 +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,15 +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';
@@ -8,44 +8,56 @@ export type RankingInfo = {
    * This field is reserved for advanced usage.
    */
   filters: number;
+
   /**
    * Position of the most important matched attribute in the attributes to index list.
    */
   firstMatchedWord: number;
+
   /**
    * Distance between the geo location in the search query and the best matching geo location in the record, divided by the geo precision (in meters).
    */
   geoDistance: number;
+
   /**
    * Precision used when computing the geo distance, in meters.
    */
   geoPrecision?: number;
+
   matchedGeoLocation?: MatchedGeoLocation;
+
   personalization?: Personalization;
+
   /**
    * Number of exactly matched words.
    */
   nbExactWords: number;
+
   /**
    * Number of typos encountered when matching the record.
    */
   nbTypos: number;
+
   /**
    * Present and set to true if a Rule promoted the hit.
    */
   promoted: boolean;
+
   /**
    * When the query contains more than one word, the sum of the distances between matched words (in meters).
    */
   proximityDistance?: number;
+
   /**
    * Custom ranking for the object, expressed as a single integer value.
    */
   userScore: number;
+
   /**
    * Number of matched words, including prefixes and typos.
    */
   words: number;
+
   /**
    * Wether the record are promoted by the re-ranking strategy.
    */

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,24 +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,13 +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 = {
-  createdAt?: string;
   /**
-   * TaskID of the task to wait for.
+   * Date of creation (ISO-8601 format).
    */
-  taskID?: number;
+  createdAt: string;
+
+  /**
+   * 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;
 };