chore: generated code for commit 156fd9e6. [skip ci]

algolia/api-clients-automation@156fd9e Co-authored-by: algolia-bot <[email protected]> Co-authored-by: Kai Welke <[email protected]> Co-authored-by: Pierre Millot <[email protected]> Co-authored-by: Clément Vannicatte <[email protected]>
algolia · Mar 12, 2024 · 6685d25 · 6685d25
1 parent 47e198e
commit 6685d25
Show file tree

Hide file tree

Showing 238 changed files with 1,064 additions and 955 deletions.
diff --git a/packages/algoliasearch/lite/model/acl.ts b/packages/algoliasearch/lite/model/acl.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.
 
 /**
- * API key permissions:  `addObject`: required to add or update records, copy or move an index. `analytics`: required to access the Analytics API. `browse`: required to view records `deleteIndex`: required to delete indices. `deleteObject`: required to delete records. `editSettings`: required to change index settings. `inference`: required to access the Inference API. `listIndexes`: required to list indices. `logs`: required to access logs of search and indexing operations. `recommendation`: required to access the Personalization and Recommend APIs. `search`: required to search records `seeUnretrievableAttributes`: required to retrieve [`unretrievableAttributes`](https://www.algolia.com/doc/api-reference/api-parameters/unretrievableAttributes/) for all operations that return records. `settings`: required to examine index settings.
+ * Access control list permissions.
  */
 export type Acl =
   | 'addObject'

diff --git a/packages/algoliasearch/lite/model/action.ts b/packages/algoliasearch/lite/model/action.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.
 
 /**
- * Type of batch operation.
+ * Type of indexing operation.
  */
 export type Action =
   | 'addObject'

diff --git a/packages/algoliasearch/lite/model/addApiKeyResponse.ts b/packages/algoliasearch/lite/model/addApiKeyResponse.ts
@@ -7,7 +7,7 @@ export type AddApiKeyResponse = {
   key: string;
 
   /**
-   * Timestamp of creation in [ISO-8601](https://wikipedia.org/wiki/ISO_8601) format.
+   * Timestamp of creation in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
    */
   createdAt: string;
 };
diff --git a/packages/algoliasearch/lite/model/anchoring.ts b/packages/algoliasearch/lite/model/anchoring.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.
 
 /**
- * Whether the pattern parameter matches the beginning (`startsWith`) or end (`endsWith`) of the query string, is an exact match (`is`), or a partial match (`contains`).
+ * Which part of the search query the pattern should match:  - `startsWith`. The pattern must match the begginning of the query. - `endsWith`. The pattern must match the end of the query. - `is`. The pattern must match the query exactly. - `contains`. The pattern must match anywhere in the query.  Empty queries are only allowed as pattern with `anchoring: is`.
  */
 export type Anchoring = 'contains' | 'endsWith' | 'is' | 'startsWith';
diff --git a/packages/algoliasearch/lite/model/apiKey.ts b/packages/algoliasearch/lite/model/apiKey.ts
@@ -7,42 +7,42 @@ import type { Acl } from './acl';
  */
 export type ApiKey = {
   /**
-   * [Permissions](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl) associated with the key.
+   * Permissions that determine the type of API requests this key can make. The required ACL is listed in each endpoint\'s reference. For more information, see [access control list](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl).
    */
   acl: Acl[];
 
   /**
-   * Description of an API key for you and your team members.
+   * Description of an API key to help you identify this API key.
    */
   description?: string;
 
   /**
-   * Restricts this API key to a list of indices or index patterns. If the list is empty, all indices are allowed. Specify either an exact index name or a pattern with a leading or trailing wildcard character (or both). For example: - `dev_*` matches all indices starting with \"dev_\" - `*_dev` matches all indices ending with \"_dev\" - `*_products_*` matches all indices containing \"_products_\".
+   * Index names or patterns that this API key can access. By default, an API key can access all indices in the same application.  You can use leading and trailing wildcard characters (`*`):  - `dev_*` matches all indices starting with \"dev_\". - `*_dev` matches all indices ending with \"_dev\". - `*_products_*` matches all indices containing \"_products_\".
    */
   indexes?: string[];
 
   /**
-   * Maximum number of hits this API key can retrieve in one query. If zero, no limit is enforced. > **Note**: Use this parameter to protect you from third-party attempts to retrieve your entire content by massively querying the index.
+   * Maximum number of results this API key can retrieve in one query. By default, there\'s no limit.
    */
   maxHitsPerQuery?: number;
 
   /**
-   * Maximum number of API calls per hour allowed from a given IP address or [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/). Each time an API call is performed with this key, a check is performed. If there were more than the specified number of calls within the last hour, the API returns an error with the status code `429` (Too Many Requests).  > **Note**: Use this parameter to protect you from third-party attempts to retrieve your entire content by massively querying the index.
+   * Maximum number of API requests allowed per IP address or [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/) per hour.  If this limit is reached, the API returns an error with status code `429`. By default, there\'s no limit.
    */
   maxQueriesPerIPPerHour?: number;
 
   /**
-   * Force some [query parameters](https://www.algolia.com/doc/api-reference/api-parameters/) to be applied for each query made with this API key. It\'s a URL-encoded query string.
+   * Query parameters to add when making API requests with this API key.  To restrict this API key to specific IP addresses, add the `restrictSources` parameter. You can only add a single source, but you can provide a range of IP addresses.  Creating an API key fails if the request is made from an IP address that\'s outside the restricted range.
    */
   queryParameters?: string;
 
   /**
-   * Restrict this API key to specific [referrers](https://www.algolia.com/doc/guides/security/api-keys/in-depth/api-key-restrictions/#http-referrers). If empty, all referrers are allowed. For example: - `https://algolia.com/_*` matches all referrers starting with \"https://algolia.com/\" - `*.algolia.com` matches all referrers ending with \".algolia.com\" - `*algolia.com*` allows everything in the domain \"algolia.com\".
+   * Allowed HTTP referrers for this API key.  By default, all referrers are allowed. You can use leading and trailing wildcard characters (`*`):  - `https://algolia.com/_*` allows all referrers starting with \"https://algolia.com/\" - `*.algolia.com` allows all referrers ending with \".algolia.com\" - `*algolia.com*` allows all referrers in the domain \"algolia.com\".  Like all HTTP headers, referrers can be spoofed. Don\'t rely on them to secure your data. For more information, see [HTTP referrer restrictions](https://www.algolia.com/doc/guides/security/security-best-practices/#http-referrers-restrictions).
    */
   referers?: string[];
 
   /**
-   * Validity duration of a key (in seconds).  The key will automatically be removed after this time has expired. The default value of 0 never expires. Short-lived API keys are useful to grant temporary access to your data. For example, in mobile apps, you can\'t [control when users update your app](https://www.algolia.com/doc/guides/security/security-best-practices/#use-secured-api-keys-in-mobile-apps). So instead of encoding keys into your app as you would for a web app, you should dynamically fetch them from your mobile app\'s backend.
+   * Duration (in seconds) after which the API key expires. By default, API keys don\'t expire.
    */
   validity?: number;
 };
diff --git a/packages/algoliasearch/lite/model/aroundPrecision.ts b/packages/algoliasearch/lite/model/aroundPrecision.ts
@@ -3,6 +3,6 @@
 import type { AroundPrecisionFromValueInner } from './aroundPrecisionFromValueInner';
 
 /**
- * Precision of a geographical search (in meters), to [group results that are more or less the same distance from a central point](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/in-depth/geo-ranking-precision/).
+ * Precision of a coordinate-based search in meters to group results with similar distances.  The Geo ranking criterion considers all matches within the same range of distances to be equal.
  */
 export type AroundPrecision = AroundPrecisionFromValueInner[] | number;
diff --git a/packages/algoliasearch/lite/model/aroundPrecisionFromValueInner.ts b/packages/algoliasearch/lite/model/aroundPrecisionFromValueInner.ts
@@ -1,7 +1,16 @@
 // 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.
 
+/**
+ * Range object with lower and upper values in meters to define custom ranges.
+ */
 export type AroundPrecisionFromValueInner = {
+  /**
+   * Lower boundary of a range in meters. The Geo ranking criterion considers all records within the range to be equal.
+   */
   from?: number;
 
+  /**
+   * Upper boundary of a range in meters. The Geo ranking criterion considers all records within the range to be equal.
+   */
   value?: number;
 };
diff --git a/packages/algoliasearch/lite/model/aroundRadius.ts b/packages/algoliasearch/lite/model/aroundRadius.ts
@@ -3,6 +3,6 @@
 import type { AroundRadiusAll } from './aroundRadiusAll';
 
 /**
- * [Maximum radius](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#increase-the-search-radius) for a geographical search (in meters).
+ * Maximum radius for a search around a central location.  This parameter works in combination with the `aroundLatLng` and `aroundLatLngViaIP` parameters. By default, the search radius is determined automatically from the density of hits around the central location. The search radius is small if there are many hits close to the central coordinates.
  */
 export type AroundRadius = AroundRadiusAll | number;
diff --git a/packages/algoliasearch/lite/model/aroundRadiusAll.ts b/packages/algoliasearch/lite/model/aroundRadiusAll.ts
@@ -1,3 +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.
 
+/**
+ * Return all records with a valid `_geoloc` attribute. Don\'t filter by distance.
+ */
 export type AroundRadiusAll = 'all';
diff --git a/packages/algoliasearch/lite/model/automaticFacetFilter.ts b/packages/algoliasearch/lite/model/automaticFacetFilter.ts
@@ -1,21 +1,21 @@
 // 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.
 
 /**
- * Automatic facet Filter.
+ * Filter or optional filter to be applied to the search.
  */
 export type AutomaticFacetFilter = {
   /**
-   * Attribute to filter on. This must match a facet placeholder in the Rule\'s pattern.
+   * Facet name to be applied as filter. The name must match placeholders in the `pattern` parameter. For example, with `pattern: {facet:genre}`, `automaticFacetFilters` must be `genre`.
    */
   facet: string;
 
   /**
-   * Score for the filter. Typically used for optional or disjunctive filters.
+   * Filter scores to give different weights to individual filters.
    */
   score?: number;
 
   /**
-   * Whether the filter is disjunctive (true) or conjunctive (false).
+   * Whether the filter is disjunctive or conjunctive.  If true the filter has multiple matches, multiple occurences are combined with the logical `OR` operation. If false, multiple occurences are combined with the logical `AND` operation.
    */
   disjunctive?: boolean;
 };
diff --git a/packages/algoliasearch/lite/model/automaticFacetFilters.ts b/packages/algoliasearch/lite/model/automaticFacetFilters.ts
@@ -3,6 +3,6 @@
 import type { AutomaticFacetFilter } from './automaticFacetFilter';
 
 /**
- * Names of facets to which automatic filtering must be applied; they must match the facet name of a facet value placeholder in the query pattern.
+ * Filter to be applied to the search.  You can use this to respond to search queries that match a facet value. For example, if users search for \"comedy\", which matches a facet value of the \"genre\" facet, you can filter the results to show the top-ranked comedy movies.
  */
 export type AutomaticFacetFilters = AutomaticFacetFilter[] | string[];