@algolia/client-search 5.0.0-alpha.106 → 5.0.0-alpha.108

package/model/builtInOperation.ts

@@ -3,13 +3,13 @@
 import type { BuiltInOperationType } from './builtInOperationType';
 
 /**
- * To update an attribute without pushing the entire record, you can use these built-in operations.
+ * Update to perform on the attribute.
  */
 export type BuiltInOperation = {
   _operation: BuiltInOperationType;
 
   /**
-   * Value that corresponds to the operation, for example an `Increment` or `Decrement` step, `Add` or `Remove` value.
+   * Value that corresponds to the operation, for example an `Increment` or `Decrement` step, or an `Add` or `Remove` value.
    */
   value: string;
 };

package/model/builtInOperationType.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.
 
 /**
- * Operation to apply to the attribute.
+ * How to change the attribute.
  */
 export type BuiltInOperationType =
   | 'Add'

package/model/clientMethodProps.ts

@@ -36,15 +36,15 @@ import type { UpdatedAtResponse } from './updatedAtResponse';
  */
 export type AddOrUpdateObjectProps = {
   /**
-   * Index on which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
   /**
-   * Unique record (object) identifier.
+   * Unique record identifier.
    */
   objectID: string;
   /**
-   * Algolia record.
+   * The record, a schemaless object with attributes that are useful in the context of search and discovery.
    */
   body: Record<string, any>;
 };
@@ -54,7 +54,7 @@ export type AddOrUpdateObjectProps = {
  */
 export type AssignUserIdProps = {
   /**
-   * UserID to assign.
+   * User ID to assign.
    */
   xAlgoliaUserID: string;
   assignUserIdParams: AssignUserIdParams;
@@ -65,7 +65,7 @@ export type AssignUserIdProps = {
  */
 export type BatchProps = {
   /**
-   * Index on which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
   batchWriteParams: BatchWriteParams;
@@ -76,7 +76,7 @@ export type BatchProps = {
  */
 export type BatchAssignUserIdsProps = {
   /**
-   * UserID to assign.
+   * User ID to assign.
    */
   xAlgoliaUserID: string;
   batchAssignUserIdsParams: BatchAssignUserIdsParams;
@@ -87,7 +87,7 @@ export type BatchAssignUserIdsProps = {
  */
 export type BatchDictionaryEntriesProps = {
   /**
-   * Dictionary to search in.
+   * Dictionary type in which to search.
    */
   dictionaryName: DictionaryType;
   batchDictionaryEntriesParams: BatchDictionaryEntriesParams;
@@ -98,7 +98,7 @@ export type BatchDictionaryEntriesProps = {
  */
 export type BrowseProps = {
   /**
-   * Index on which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
   browseParams?: BrowseParams;
@@ -109,7 +109,7 @@ export type BrowseProps = {
  */
 export type ClearObjectsProps = {
   /**
-   * Index on which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
 };
@@ -119,11 +119,11 @@ export type ClearObjectsProps = {
  */
 export type ClearRulesProps = {
   /**
-   * Index on which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
   /**
-   * Indicates whether changed index settings are forwarded to the replica indices.
+   * Whether changes are applied to replica indices.
    */
   forwardToReplicas?: boolean;
 };
@@ -133,11 +133,11 @@ export type ClearRulesProps = {
  */
 export type ClearSynonymsProps = {
   /**
-   * Index on which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
   /**
-   * Indicates whether changed index settings are forwarded to the replica indices.
+   * Whether changes are applied to replica indices.
    */
   forwardToReplicas?: boolean;
 };
@@ -221,7 +221,7 @@ export type DeleteApiKeyProps = {
  */
 export type DeleteByProps = {
   /**
-   * Index on which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
   deleteByParams: DeleteByParams;
@@ -232,7 +232,7 @@ export type DeleteByProps = {
  */
 export type DeleteIndexProps = {
   /**
-   * Index on which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
 };
@@ -242,11 +242,11 @@ export type DeleteIndexProps = {
  */
 export type DeleteObjectProps = {
   /**
-   * Index on which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
   /**
-   * Unique record (object) identifier.
+   * Unique record identifier.
    */
   objectID: string;
 };
@@ -256,7 +256,7 @@ export type DeleteObjectProps = {
  */
 export type DeleteRuleProps = {
   /**
-   * Index on which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
   /**
@@ -264,7 +264,7 @@ export type DeleteRuleProps = {
    */
   objectID: string;
   /**
-   * Indicates whether changed index settings are forwarded to the replica indices.
+   * Whether changes are applied to replica indices.
    */
   forwardToReplicas?: boolean;
 };
@@ -284,7 +284,7 @@ export type DeleteSourceProps = {
  */
 export type DeleteSynonymProps = {
   /**
-   * Index on which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
   /**
@@ -292,7 +292,7 @@ export type DeleteSynonymProps = {
    */
   objectID: string;
   /**
-   * Indicates whether changed index settings are forwarded to the replica indices.
+   * Whether changes are applied to replica indices.
    */
   forwardToReplicas?: boolean;
 };
@@ -312,7 +312,7 @@ export type GetApiKeyProps = {
  */
 export type GetLogsProps = {
   /**
-   * First log entry to retrieve. Sorted by decreasing date with 0 being the most recent.
+   * First log entry to retrieve. The most recent entries are listed first.
    */
   offset?: number;
   /**
@@ -320,11 +320,11 @@ export type GetLogsProps = {
    */
   length?: number;
   /**
-   * Index for which log entries should be retrieved. When omitted, log entries are retrieved for all indices.
+   * Index for which to retrieve log entries. By default, log entries are retrieved for all indices.
    */
   indexName?: string;
   /**
-   * Type of log entries to retrieve. When omitted, all log entries are retrieved.
+   * Type of log entries to retrieve. By default, all log entries are retrieved.
    */
   type?: LogType;
 };
@@ -334,15 +334,15 @@ export type GetLogsProps = {
  */
 export type GetObjectProps = {
   /**
-   * Index on which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
   /**
-   * Unique record (object) identifier.
+   * Unique record identifier.
    */
   objectID: string;
   /**
-   * Attributes to include with the records in the response. This is useful to reduce the size of the API response. By default, all retrievable attributes are returned. `objectID` is always retrieved, even when not specified. [`unretrievableAttributes`](https://www.algolia.com/doc/api-reference/api-parameters/unretrievableAttributes/) won\'t be retrieved unless the request is authenticated with the admin API key.
+   * Attributes to include with the records in the response. This is useful to reduce the size of the API response. By default, all retrievable attributes are returned.  `objectID` is always retrieved.  Attributes included in `unretrievableAttributes` won\'t be retrieved unless the request is authenticated with the admin API key.
    */
   attributesToRetrieve?: string[];
 };
@@ -352,7 +352,7 @@ export type GetObjectProps = {
  */
 export type GetRuleProps = {
   /**
-   * Index on which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
   /**
@@ -366,7 +366,7 @@ export type GetRuleProps = {
  */
 export type GetSettingsProps = {
   /**
-   * Index on which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
 };
@@ -376,7 +376,7 @@ export type GetSettingsProps = {
  */
 export type GetSynonymProps = {
   /**
-   * Index on which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
   /**
@@ -390,7 +390,7 @@ export type GetSynonymProps = {
  */
 export type GetTaskProps = {
   /**
-   * Index on which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
   /**
@@ -404,7 +404,7 @@ export type GetTaskProps = {
  */
 export type GetUserIdProps = {
   /**
-   * UserID to assign.
+   * User ID to assign.
    */
   userID: string;
 };
@@ -414,7 +414,7 @@ export type GetUserIdProps = {
  */
 export type HasPendingMappingsProps = {
   /**
-   * Indicates whether to include the cluster\'s pending mapping state in the response.
+   * Whether to include the cluster\'s pending mapping state in the response.
    */
   getClusters?: boolean;
 };
@@ -424,11 +424,11 @@ export type HasPendingMappingsProps = {
  */
 export type ListIndicesProps = {
   /**
-   * Returns the requested page number. The page size is determined by the `hitsPerPage` parameter. You can see the number of available pages in the `nbPages` response attribute. When `page` is null, the API response is not paginated.
+   * Requested page of the API response. If `null`, the API response is not paginated.
    */
   page?: number;
   /**
-   * Maximum number of hits per page.
+   * Number of hits per page.
    */
   hitsPerPage?: number;
 };
@@ -438,11 +438,11 @@ export type ListIndicesProps = {
  */
 export type ListUserIdsProps = {
   /**
-   * Returns the requested page number. The page size is determined by the `hitsPerPage` parameter. You can see the number of available pages in the `nbPages` response attribute. When `page` is null, the API response is not paginated.
+   * Requested page of the API response. If `null`, the API response is not paginated.
    */
   page?: number;
   /**
-   * Maximum number of hits per page.
+   * Number of hits per page.
    */
   hitsPerPage?: number;
 };
@@ -452,7 +452,7 @@ export type ListUserIdsProps = {
  */
 export type OperationIndexProps = {
   /**
-   * Index on which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
   operationIndexParams: OperationIndexParams;
@@ -463,19 +463,19 @@ export type OperationIndexProps = {
  */
 export type PartialUpdateObjectProps = {
   /**
-   * Index on which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
   /**
-   * Unique record (object) identifier.
+   * Unique record identifier.
    */
   objectID: string;
   /**
-   * Object with attributes to update.
+   * Attributes with their values.
    */
   attributesToUpdate: Record<string, AttributeToUpdate>;
   /**
-   * Indicates whether to create a new record if it doesn\'t exist yet.
+   * Whether to create a new record if it doesn\'t exist.
    */
   createIfNotExists?: boolean;
 };
@@ -485,7 +485,7 @@ export type PartialUpdateObjectProps = {
  */
 export type RemoveUserIdProps = {
   /**
-   * UserID to assign.
+   * User ID to assign.
    */
   userID: string;
 };
@@ -515,11 +515,11 @@ export type RestoreApiKeyProps = {
  */
 export type SaveObjectProps = {
   /**
-   * Index on which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
   /**
-   * The Algolia record.
+   * The record, a schemaless object with attributes that are useful in the context of search and discovery.
    */
   body: Record<string, any>;
 };
@@ -529,7 +529,7 @@ export type SaveObjectProps = {
  */
 export type SaveRuleProps = {
   /**
-   * Index on which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
   /**
@@ -538,7 +538,7 @@ export type SaveRuleProps = {
   objectID: string;
   rule: Rule;
   /**
-   * Indicates whether changed index settings are forwarded to the replica indices.
+   * Whether changes are applied to replica indices.
    */
   forwardToReplicas?: boolean;
 };
@@ -548,16 +548,16 @@ export type SaveRuleProps = {
  */
 export type SaveRulesProps = {
   /**
-   * Index on which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
   rules: Rule[];
   /**
-   * Indicates whether changed index settings are forwarded to the replica indices.
+   * Whether changes are applied to replica indices.
    */
   forwardToReplicas?: boolean;
   /**
-   * Indicates whether existing rules should be deleted before adding this batch.
+   * Whether existing rules should be deleted before adding this batch.
    */
   clearExistingRules?: boolean;
 };
@@ -567,7 +567,7 @@ export type SaveRulesProps = {
  */
 export type SaveSynonymProps = {
   /**
-   * Index on which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
   /**
@@ -576,7 +576,7 @@ export type SaveSynonymProps = {
   objectID: string;
   synonymHit: SynonymHit;
   /**
-   * Indicates whether changed index settings are forwarded to the replica indices.
+   * Whether changes are applied to replica indices.
    */
   forwardToReplicas?: boolean;
 };
@@ -586,16 +586,16 @@ export type SaveSynonymProps = {
  */
 export type SaveSynonymsProps = {
   /**
-   * Index on which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
   synonymHit: SynonymHit[];
   /**
-   * Indicates whether changed index settings are forwarded to the replica indices.
+   * Whether changes are applied to replica indices.
    */
   forwardToReplicas?: boolean;
   /**
-   * Indicates whether to replace all synonyms in the index with the ones sent with this request.
+   * Whether to replace all synonyms in the index with the ones sent with this request.
    */
   replaceExistingSynonyms?: boolean;
 };
@@ -637,7 +637,7 @@ export type LegacySearchMethodProps = LegacySearchQuery[];
  */
 export type SearchDictionaryEntriesProps = {
   /**
-   * Dictionary to search in.
+   * Dictionary type in which to search.
    */
   dictionaryName: DictionaryType;
   searchDictionaryEntriesParams: SearchDictionaryEntriesParams;
@@ -648,11 +648,11 @@ export type SearchDictionaryEntriesProps = {
  */
 export type SearchForFacetValuesProps = {
   /**
-   * Index on which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
   /**
-   * Facet name.
+   * Facet attribute in which to search for values.  This attribute must be included in the `attributesForFaceting` index setting with the `searchable()` modifier.
    */
   facetName: string;
   searchForFacetValuesRequest?: SearchForFacetValuesRequest;
@@ -663,7 +663,7 @@ export type SearchForFacetValuesProps = {
  */
 export type SearchRulesProps = {
   /**
-   * Index on which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
   searchRulesParams?: SearchRulesParams;
@@ -674,7 +674,7 @@ export type SearchRulesProps = {
  */
 export type SearchSingleIndexProps = {
   /**
-   * Index on which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
   searchParams?: SearchParams;
@@ -685,7 +685,7 @@ export type SearchSingleIndexProps = {
  */
 export type SearchSynonymsProps = {
   /**
-   * Index on which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
   /**
@@ -699,12 +699,12 @@ export type SearchSynonymsProps = {
  */
 export type SetSettingsProps = {
   /**
-   * Index on which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
   indexSettings: IndexSettings;
   /**
-   * Indicates whether changed index settings are forwarded to the replica indices.
+   * Whether changes are applied to replica indices.
    */
   forwardToReplicas?: boolean;
 };

package/model/condition.ts

@@ -4,19 +4,24 @@ import type { Anchoring } from './anchoring';
 
 export type Condition = {
   /**
-   * Query pattern syntax.
+   * Query pattern that triggers the rule.  You can use either a literal string, or a special pattern `{facet:ATTRIBUTE}`, where `ATTRIBUTE` is a facet name. The rule is triggered if the query matches the literal string or a value of the specified facet. For example, with `pattern: {facet:genre}`, the rule is triggered when users search for a genre, such as \"comedy\".
    */
   pattern?: string;
 
   anchoring?: Anchoring;
 
   /**
-   * Whether the pattern matches on plurals, synonyms, and typos.
+   * Whether the pattern should match plurals, synonyms, and typos.
    */
   alternatives?: boolean;
 
   /**
-   * Rule context format: [A-Za-z0-9_-]+).
+   * An additional restriction that only triggers the rule, when the search has the same value as `ruleContexts` parameter. For example, if `context: mobile`, the rule is only triggered when the search request has a matching `ruleContexts: mobile`. A rule context must only contain alphanumeric characters.
    */
   context?: string;
+
+  /**
+   * Filters that trigger the rule.  You can add add filters using the syntax `facet:value` so that the rule is triggered, when the specific filter is selected. You can use `filters` on its own or combine it with the `pattern` parameter.
+   */
+  filters?: string;
 };

package/model/consequence.ts

@@ -5,28 +5,28 @@ import type { ConsequenceParams } from './consequenceParams';
 import type { Promote } from './promote';
 
 /**
- * [Consequences](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/#consequences) of a rule.
+ * Effect of the rule.  For more information, see [Consequences](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/#consequences).
  */
 export type Consequence = {
   params?: ConsequenceParams;
 
   /**
-   * Records to promote.
+   * Records you want to pin to a specific position in the search results.  You can promote up to 300 records, either individually, or as groups of up to 100 records each.
    */
   promote?: Promote[];
 
   /**
-   * Only use in combination with the `promote` consequence. When `true`, promoted results will be restricted to match the filters of the current search. When `false`, the promoted results will show up regardless of the filters.
+   * Whether promoted records must match an active filter for the consequence to be applied.  This ensures that user actions (filtering the search) are given a higher precendence. For example, if you promote a record with the `color: red` attribute, and the user filters the search for `color: blue`, the \"red\" record won\'t be shown.
    */
   filterPromotes?: boolean;
 
   /**
-   * Records to hide. By default, you can hide up to 50 records per rule.
+   * Records you want to hide from the search results.
    */
   hide?: ConsequenceHide[];
 
   /**
-   * Custom JSON object that will be appended to the userData array in the response. This object isn\'t interpreted by the API. It\'s limited to 1kB of minified JSON.
+   * A JSON object with custom data that will be appended to the `userData` array in the response. This object isn\'t interpreted by the API and is limited to 1 kB of minified JSON.
    */
   userData?: any | null;
 };

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.
+   * Timestamp of creation in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) 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/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 the search so that only records with matching values are included in the results.  These filters are supported:  - **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[][];
 };