Skip to content

Commit 046709e

Browse files
algolia-botshortcuts
algolia-bot
and
shortcuts
committed
chore: generated code for commit a11e84da. [skip ci]
algolia/api-clients-automation@a11e84d Co-authored-by: algolia-bot <[email protected]> Co-authored-by: Clément Vannicatte <[email protected]>
1 parent 60e0958 commit 046709e

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

64 files changed

+823
-484
lines changed

‎packages/algoliasearch/.openapi-generator-ignore

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# OpenAPI Generator Ignore
2+
# Generated by openapi-generator https://github.com/openapitools/openapi-generator
3+
4+
# Use this file to prevent files from being overwritten by the generator.
5+
# The patterns follow closely to .gitignore or .dockerignore.
6+
7+
# As an example, the C# client generator defines ApiClient.cs.
8+
# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
9+
#ApiClient.cs
10+
11+
# You can match any string of characters against a directory, file or extension with a single asterisk (*):
12+
#foo/*/qux
13+
# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
14+
15+
# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
16+
#foo/**/qux
17+
# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
18+
19+
# You can also negate patterns with an exclamation (!).
20+
# For example, you can ignore all files in a docs folder with the file extension .md:
21+
#docs/*.md
22+
# Then explicitly reverse the ignore rule for a single file:
23+
#!docs/README.md

‎packages/algoliasearch/lite/model/baseIndexSettings.ts

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ export type BaseIndexSettings = {
1212
*/
1313
disableTypoToleranceOnWords?: string[];
1414
/**
15-
* Specify on which attributes to apply transliteration.
15+
* Specify on which attributes in your index Algolia should apply Japanese transliteration to make words indexed in Katakana or Kanji searchable in Hiragana.
1616
*/
1717
attributesToTransliterate?: string[];
1818
/**
@@ -51,4 +51,8 @@ export type BaseIndexSettings = {
5151
* Lets you store custom data in your indices.
5252
*/
5353
userData?: Record<string, any>;
54+
/**
55+
* Overrides Algolia\'s default normalization.
56+
*/
57+
customNormalization?: Record<string, Record<string, string>>;
5458
};

‎packages/algoliasearch/lite/model/baseSearchParams.ts

Lines changed: 3 additions & 126 deletions
Original file line numberDiff line numberDiff line change
@@ -1,127 +1,4 @@
1-
import type { AroundRadius } from './aroundRadius';
2-
import type { FacetFilters } from './facetFilters';
3-
import type { NumericFilters } from './numericFilters';
4-
import type { OptionalFilters } from './optionalFilters';
5-
import type { ReRankingApplyFilter } from './reRankingApplyFilter';
6-
import type { TagFilters } from './tagFilters';
1+
import type { BaseSearchParamsWithoutQuery } from './baseSearchParamsWithoutQuery';
2+
import type { SearchParamsQuery } from './searchParamsQuery';
73

8-
export type BaseSearchParams = {
9-
/**
10-
* The text to search in the index.
11-
*/
12-
query?: string;
13-
/**
14-
* Overrides the query parameter and performs a more generic search that can be used to find \"similar\" results.
15-
*/
16-
similarQuery?: string;
17-
/**
18-
* Filter the query with numeric, facet and/or tag filters.
19-
*/
20-
filters?: string;
21-
facetFilters?: FacetFilters;
22-
optionalFilters?: OptionalFilters;
23-
numericFilters?: NumericFilters;
24-
tagFilters?: TagFilters;
25-
/**
26-
* Determines how to calculate the total score for filtering.
27-
*/
28-
sumOrFiltersScores?: boolean;
29-
/**
30-
* Retrieve facets and their facet values.
31-
*/
32-
facets?: string[];
33-
/**
34-
* Maximum number of facet values to return for each facet during a regular search.
35-
*/
36-
maxValuesPerFacet?: number;
37-
/**
38-
* Force faceting to be applied after de-duplication (via the Distinct setting).
39-
*/
40-
facetingAfterDistinct?: boolean;
41-
/**
42-
* Controls how facet values are fetched.
43-
*/
44-
sortFacetValuesBy?: string;
45-
/**
46-
* Specify the page to retrieve.
47-
*/
48-
page?: number;
49-
/**
50-
* Specify the offset of the first hit to return.
51-
*/
52-
offset?: number;
53-
/**
54-
* Set the number of hits to retrieve (used only with offset).
55-
*/
56-
length?: number;
57-
/**
58-
* Search for entries around a central geolocation, enabling a geo search within a circular area.
59-
*/
60-
aroundLatLng?: string;
61-
/**
62-
* Search for entries around a given location automatically computed from the requester\'s IP address.
63-
*/
64-
aroundLatLngViaIP?: boolean;
65-
aroundRadius?: AroundRadius;
66-
/**
67-
* Precision of geo search (in meters), to add grouping by geo location to the ranking formula.
68-
*/
69-
aroundPrecision?: number;
70-
/**
71-
* Minimum radius (in meters) used for a geo search when aroundRadius is not set.
72-
*/
73-
minimumAroundRadius?: number;
74-
/**
75-
* Search inside a rectangular area (in geo coordinates).
76-
*/
77-
insideBoundingBox?: number[];
78-
/**
79-
* Search inside a polygon (in geo coordinates).
80-
*/
81-
insidePolygon?: number[];
82-
/**
83-
* This parameter changes the default values of certain parameters and settings that work best for a natural language query, such as ignorePlurals, removeStopWords, removeWordsIfNoResults, analyticsTags and ruleContexts. These parameters and settings work well together when the query is formatted in natural language instead of keywords, for example when your user performs a voice search.
84-
*/
85-
naturalLanguages?: string[];
86-
/**
87-
* Enables contextual rules.
88-
*/
89-
ruleContexts?: string[];
90-
/**
91-
* Define the impact of the Personalization feature.
92-
*/
93-
personalizationImpact?: number;
94-
/**
95-
* Associates a certain user token with the current search.
96-
*/
97-
userToken?: string;
98-
/**
99-
* Retrieve detailed ranking information.
100-
*/
101-
getRankingInfo?: boolean;
102-
/**
103-
* Enable the Click Analytics feature.
104-
*/
105-
clickAnalytics?: boolean;
106-
/**
107-
* Whether the current query will be taken into account in the Analytics.
108-
*/
109-
analytics?: boolean;
110-
/**
111-
* List of tags to apply to the query for analytics purposes.
112-
*/
113-
analyticsTags?: string[];
114-
/**
115-
* Whether to include or exclude a query from the processing-time percentile computation.
116-
*/
117-
percentileComputation?: boolean;
118-
/**
119-
* Whether this search should participate in running AB tests.
120-
*/
121-
enableABTest?: boolean;
122-
/**
123-
* Whether this search should use AI Re-Ranking.
124-
*/
125-
enableReRanking?: boolean;
126-
reRankingApplyFilter?: ReRankingApplyFilter;
127-
};
4+
export type BaseSearchParams = BaseSearchParamsWithoutQuery & SearchParamsQuery;

‎packages/algoliasearch/lite/model/baseSearchParamsWithoutQuery.ts

Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
1+
import type { AroundRadius } from './aroundRadius';
2+
import type { FacetFilters } from './facetFilters';
3+
import type { NumericFilters } from './numericFilters';
4+
import type { OptionalFilters } from './optionalFilters';
5+
import type { ReRankingApplyFilter } from './reRankingApplyFilter';
6+
import type { TagFilters } from './tagFilters';
7+
8+
export type BaseSearchParamsWithoutQuery = {
9+
/**
10+
* Overrides the query parameter and performs a more generic search that can be used to find \"similar\" results.
11+
*/
12+
similarQuery?: string;
13+
/**
14+
* Filter the query with numeric, facet and/or tag filters.
15+
*/
16+
filters?: string;
17+
facetFilters?: FacetFilters;
18+
optionalFilters?: OptionalFilters;
19+
numericFilters?: NumericFilters;
20+
tagFilters?: TagFilters;
21+
/**
22+
* Determines how to calculate the total score for filtering.
23+
*/
24+
sumOrFiltersScores?: boolean;
25+
/**
26+
* Retrieve facets and their facet values.
27+
*/
28+
facets?: string[];
29+
/**
30+
* Maximum number of facet values to return for each facet during a regular search.
31+
*/
32+
maxValuesPerFacet?: number;
33+
/**
34+
* Force faceting to be applied after de-duplication (via the Distinct setting).
35+
*/
36+
facetingAfterDistinct?: boolean;
37+
/**
38+
* Controls how facet values are fetched.
39+
*/
40+
sortFacetValuesBy?: string;
41+
/**
42+
* Specify the page to retrieve.
43+
*/
44+
page?: number;
45+
/**
46+
* Specify the offset of the first hit to return.
47+
*/
48+
offset?: number;
49+
/**
50+
* Set the number of hits to retrieve (used only with offset).
51+
*/
52+
length?: number;
53+
/**
54+
* Search for entries around a central geolocation, enabling a geo search within a circular area.
55+
*/
56+
aroundLatLng?: string;
57+
/**
58+
* Search for entries around a given location automatically computed from the requester\'s IP address.
59+
*/
60+
aroundLatLngViaIP?: boolean;
61+
aroundRadius?: AroundRadius;
62+
/**
63+
* Precision of geo search (in meters), to add grouping by geo location to the ranking formula.
64+
*/
65+
aroundPrecision?: number;
66+
/**
67+
* Minimum radius (in meters) used for a geo search when aroundRadius is not set.
68+
*/
69+
minimumAroundRadius?: number;
70+
/**
71+
* Search inside a rectangular area (in geo coordinates).
72+
*/
73+
insideBoundingBox?: number[];
74+
/**
75+
* Search inside a polygon (in geo coordinates).
76+
*/
77+
insidePolygon?: number[];
78+
/**
79+
* This parameter changes the default values of certain parameters and settings that work best for a natural language query, such as ignorePlurals, removeStopWords, removeWordsIfNoResults, analyticsTags and ruleContexts. These parameters and settings work well together when the query is formatted in natural language instead of keywords, for example when your user performs a voice search.
80+
*/
81+
naturalLanguages?: string[];
82+
/**
83+
* Enables contextual rules.
84+
*/
85+
ruleContexts?: string[];
86+
/**
87+
* Define the impact of the Personalization feature.
88+
*/
89+
personalizationImpact?: number;
90+
/**
91+
* Associates a certain user token with the current search.
92+
*/
93+
userToken?: string;
94+
/**
95+
* Retrieve detailed ranking information.
96+
*/
97+
getRankingInfo?: boolean;
98+
/**
99+
* Enable the Click Analytics feature.
100+
*/
101+
clickAnalytics?: boolean;
102+
/**
103+
* Whether the current query will be taken into account in the Analytics.
104+
*/
105+
analytics?: boolean;
106+
/**
107+
* List of tags to apply to the query for analytics purposes.
108+
*/
109+
analyticsTags?: string[];
110+
/**
111+
* Whether to include or exclude a query from the processing-time percentile computation.
112+
*/
113+
percentileComputation?: boolean;
114+
/**
115+
* Whether this search should participate in running AB tests.
116+
*/
117+
enableABTest?: boolean;
118+
/**
119+
* Whether this search should use AI Re-Ranking.
120+
*/
121+
enableReRanking?: boolean;
122+
reRankingApplyFilter?: ReRankingApplyFilter | null;
123+
};

‎packages/algoliasearch/lite/model/consequenceParams.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
import type { BaseSearchParams } from './baseSearchParams';
1+
import type { BaseSearchParamsWithoutQuery } from './baseSearchParamsWithoutQuery';
22
import type { IndexSettingsAsSearchParams } from './indexSettingsAsSearchParams';
33
import type { Params } from './params';
44

5-
export type ConsequenceParams = BaseSearchParams &
5+
export type ConsequenceParams = BaseSearchParamsWithoutQuery &
66
IndexSettingsAsSearchParams &
77
Params;

‎packages/algoliasearch/lite/model/consequenceQuery.ts

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,6 @@
1-
import type { Edit } from './edit';
1+
import type { ConsequenceQueryObject } from './consequenceQueryObject';
22

3-
export type ConsequenceQuery = {
4-
/**
5-
* Words to remove.
6-
*/
7-
remove?: string[];
8-
/**
9-
* Edits to apply.
10-
*/
11-
edits?: Edit[];
12-
};
3+
/**
4+
* 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).
5+
*/
6+
export type ConsequenceQuery = ConsequenceQueryObject | string;

‎packages/algoliasearch/lite/model/consequenceQueryObject.ts

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
import type { Edit } from './edit';
2+
3+
export type ConsequenceQueryObject = {
4+
/**
5+
* Words to remove.
6+
*/
7+
remove?: string[];
8+
/**
9+
* Edits to apply.
10+
*/
11+
edits?: Edit[];
12+
};

‎packages/algoliasearch/lite/model/facetFilters.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1+
import type { MixedSearchFilters } from './mixedSearchFilters';
2+
13
/**
24
* Filter hits by facet value.
35
*/
4-
export type FacetFilters = string[] | string[][];
6+
export type FacetFilters = MixedSearchFilters[] | string;

‎packages/algoliasearch/lite/model/index.ts

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ export * from './automaticFacetFilters';
1313
export * from './baseBrowseResponse';
1414
export * from './baseIndexSettings';
1515
export * from './baseSearchParams';
16+
export * from './baseSearchParamsWithoutQuery';
1617
export * from './baseSearchResponse';
1718
export * from './browseResponse';
1819
export * from './builtInOperation';
@@ -22,6 +23,7 @@ export * from './consequence';
2223
export * from './consequenceHide';
2324
export * from './consequenceParams';
2425
export * from './consequenceQuery';
26+
export * from './consequenceQueryObject';
2527
export * from './createdAtObject';
2628
export * from './dictionaryAction';
2729
export * from './dictionaryEntry';
@@ -48,20 +50,22 @@ export * from './listIndicesResponse';
4850
export * from './logType';
4951
export * from './matchLevel';
5052
export * from './matchedGeoLocation';
53+
export * from './mixedSearchFilters';
5154
export * from './numericFilters';
5255
export * from './operationType';
5356
export * from './optionalFilters';
5457
export * from './params';
5558
export * from './personalization';
5659
export * from './promote';
60+
export * from './promoteObjectID';
61+
export * from './promoteObjectIDs';
5762
export * from './queryType';
5863
export * from './rankingInfo';
5964
export * from './reRankingApplyFilter';
6065
export * from './removeStopWords';
6166
export * from './removeWordsIfNoResults';
6267
export * from './renderingContent';
6368
export * from './rule';
64-
export * from './schemasQuery';
6569
export * from './scopeType';
6670
export * from './searchForFacets';
6771
export * from './searchForFacetsOptions';
@@ -71,6 +75,7 @@ export * from './searchHits';
7175
export * from './searchMethodParams';
7276
export * from './searchParams';
7377
export * from './searchParamsObject';
78+
export * from './searchParamsQuery';
7479
export * from './searchParamsString';
7580
export * from './searchQuery';
7681
export * from './searchResponse';

‎packages/algoliasearch/lite/model/mixedSearchFilters.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
export type MixedSearchFilters = string[] | string;

0 commit comments

Comments
 (0)