@algolia/client-search 5.0.0-alpha.11 → 5.0.0-alpha.111

package/model/log.ts

@@ -1,45 +1,45 @@
-// 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.
+   * Date and time of the API request, in RFC 3339 format.
    */
   timestamp: string;
 
   /**
-   * HTTP method of the performed request.
+   * HTTP method of the request.
    */
   method: string;
 
   /**
-   * HTTP response code.
+   * HTTP status code of the response.
    */
   answer_code: string;
 
   /**
-   * Request body. Truncated after 1000 characters.
+   * Request body.
    */
   query_body: string;
 
   /**
-   * Answer body. Truncated after 1000 characters.
+   * Response body.
    */
   answer: string;
 
   /**
-   * Request URL.
+   * URL of the API endpoint.
    */
   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 keys are obfuscated).
    */
   query_headers: string;
 
@@ -49,12 +49,12 @@ export type Log = {
   sha1: string;
 
   /**
-   * Number of API calls.
+   * Number of API requests.
    */
   nb_api_calls: string;
 
   /**
-   * Processing time for the query. It doesn\'t include network time.
+   * Processing time for the query in milliseconds. This doesn\'t include latency due to the network.
    */
   processing_time_ms: string;
 
@@ -69,12 +69,12 @@ export type Log = {
   query_params?: string;
 
   /**
-   * Number of hits returned for the query.
+   * Number of search results (hits) returned for the query.
    */
   query_nb_hits?: string;
 
   /**
-   * Array of all performed queries for the given request.
+   * Queries performed for the given request.
    */
   inner_queries?: LogQuery[];
 };

package/model/logQuery.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 LogQuery = {
   /**
@@ -7,12 +7,12 @@ export type LogQuery = {
   index_name?: string;
 
   /**
-   * User identifier.
+   * A 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,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.
 
 /**
- * Indicates how well the attribute matched the search query.
+ * Whether the whole query string matches or only a part.
  */
 export type MatchLevel = 'full' | 'none' | 'partial';

package/model/matchedGeoLocation.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 MatchedGeoLocation = {
   /**

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.  This setting only applies to indices, for which Algolia enabled NeuralSearch for you.
+ */
+export type Mode = 'keywordSearch' | 'neuralSearch';

package/model/multipleBatchRequest.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 { Action } from './action';
 
@@ -6,7 +6,7 @@ export type MultipleBatchRequest = {
   action: Action;
 
   /**
-   * Arguments to the operation (depends on the type of the operation).
+   * Operation arguments (varies with specified `action`).
    */
   body: Record<string, any>;
 

package/model/multipleBatchResponse.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 MultipleBatchResponse = {
   /**
-   * List of tasksIDs per index.
+   * Task IDs. One for each index.
    */
   taskID: Record<string, number>;
 
   /**
-   * List of objectID.
+   * Unique record identifiers.
    */
   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 by numeric facets.  **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.**  You can use numeric comparison operators: `<`, `<=`, `=`, `!=`, `>`, `>=`. Comparsions are precise up to 3 decimals. You can also provide ranges: `facet:<lower> TO <upper>`. The range includes the lower and upper boundaries. The same combination rules apply as for `facetFilters`.
  */
 export type NumericFilters = MixedSearchFilters[] | string;

package/model/operationIndexParams.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 { OperationType } from './operationType';
 import type { ScopeType } from './scopeType';
@@ -7,12 +7,12 @@ export type OperationIndexParams = {
   operation: OperationType;
 
   /**
-   * The Algolia index name.
+   * 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.
+   * **Only for copying.**  If you specify a scope, only the selected scopes are copied. Records and the other scopes are left unchanged. If you omit the `scope` parameter, everything is copied: records, settings, synonyms, and rules.
    */
   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 on the index.
  */
 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.
+ * Filters to promote or demote records in the search results.  Optional filters work like facet filters, but they don\'t exclude records from the search results. Records that match the optional filter rank before records that don\'t match. If you\'re using a negative filter `facet:-value`, matching records rank after records that don\'t match.  - Optional filters don\'t work on virtual replicas. - Optional filters are applied _after_ sort-by attributes. - Optional filters don\'t work with numeric attributes.
  */
 export type OptionalFilters = MixedSearchFilters[] | string;

package/model/params.ts

@@ -1,11 +1,11 @@
-// 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.
+ * Parameters to apply to this search.  You can use all search parameters, plus special `automaticFacetFilters`, `automaticOptionalFacetFilters`, and `query`.
  */
 export type Params = {
   query?: ConsequenceQuery;

package/model/personalization.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 Personalization = {
   /**

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 record identifier.
    */
   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.
+   * Position in the search results where you want to show the promoted records.
    */
   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.
+   * Object IDs of the records you want to promote.  The records are placed as a group at the `position`. For example, if you want to promote four records to position `0`, they will be the first four search results.
    */
   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.
+   * Position in the search results where you want to show the promoted records.
    */
   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 if and how query words are interpreted as prefixes.  By default, only the last query word is treated as prefix (`prefixLast`). To turn off prefix search, use `prefixNone`. Avoid `prefixAll`, which treats all query words as prefixes. This might lead to counterintuitive results and makes your search slower.  For more information, see [Prefix searching](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,16 +1,19 @@
-// 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';
 
+/**
+ * Object with detailed information about the record\'s ranking.
+ */
 export type RankingInfo = {
   /**
-   * This field is reserved for advanced usage.
+   * Whether a filter matched the query.
    */
   filters: number;
 
   /**
-   * Position of the most important matched attribute in the attributes to index list.
+   * Position of the first matched word in the best matching attribute of the record.
    */
   firstMatchedWord: number;
 
@@ -39,27 +42,27 @@ export type RankingInfo = {
   nbTypos: number;
 
   /**
-   * Present and set to true if a Rule promoted the hit.
+   * Whether the record was promoted by a rule.
    */
   promoted: boolean;
 
   /**
-   * When the query contains more than one word, the sum of the distances between matched words (in meters).
+   * Number of words between multiple matches in the query plus 1. For single word queries, `proximityDistance` is 0.
    */
   proximityDistance?: number;
 
   /**
-   * Custom ranking for the object, expressed as a single integer value.
+   * Overall ranking of the record, expressed as a single integer. This attribute is internal.
    */
   userScore: number;
 
   /**
-   * Number of matched words, including prefixes and typos.
+   * Number of matched words.
    */
   words: number;
 
   /**
-   * Wether the record are promoted by the re-ranking strategy.
+   * Whether the record is re-ranked.
    */
   promotedByReRanking?: boolean;
 };

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.
+ * Restrict [Dynamic Re-ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/) to records that match these filters.
  */
 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,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 { SupportedLanguage } from './supportedLanguage';
 
 /**
- * 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 words from the search query.  Stop words are common words like articles, conjunctions, prepositions, or pronouns that have little or no meaning on their own. In English, \"the\", \"a\", or \"and\" are stop words.  You should only use this feature for the languages used in your index.
  */
-export type RemoveStopWords = string[] | boolean;
+export type RemoveStopWords = SupportedLanguage[] | 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).
+   * Date and time when the object was deleted, in RFC 3339 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 for removing words from the query when it doesn\'t return any results. This helps to avoid returning empty search results.  - `none`.   No words are removed when a query doesn\'t return results.  - `lastWords`.   Treat the last (then second to last, then third to last) word as optional,   until there are results or at most 5 words have been removed.  - `firstWords`.   Treat the first (then second, then third) word as optional,   until there are results or at most 5 words have been removed.  - `allOptional`.   Treat all words as optional.  For more information, see [Remove words to improve results](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/in-depth/why-use-remove-words-if-no-results/).
  */
 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 data that can be used in the search UI.  You can use this to control aspects of your search UI, such as, the order of facet names and values without changing your frontend code.
  */
 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).
+   * Date and time when the object was updated, in RFC 3339 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 of 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 that trigger a rule.  Some consequences require specific conditions or don\'t require any condition. For more information, see [Conditions](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/#conditions).
    */
   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 to help you distinguish between different rules.
    */
   description?: string;
 
   /**
-   * Whether the Rule is enabled. Disabled Rules remain in the index, but aren\'t applied at query time.
+   * Whether the rule is active.
    */
   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.
+   * Time periods when the rule is active.
    */
   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 and time when the object was created, in RFC 3339 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](#tag/Indices/operation/getTask) and this `taskID`.
    */
   taskID: number;
 
   /**
-   * Unique identifier of the object.
+   * Unique record 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](#tag/Indices/operation/getTask) and this `taskID`.
    */
   taskID: number;
 
   /**
-   * Date of last update (ISO-8601 format).
+   * Date and time when the object was updated, in RFC 3339 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';